ae2f_docs
Loading...
Searching...
No Matches
Inet.h File Reference
#include "../Sys.h"
#include "./WSock.h"
#include "./Inet-WIN.h"
#include "./Inet-POSIX.h"

Go to the source code of this file.

Macros

#define _ae2f_SysInetMkData
#define ae2f_SysInetMkData_DEC(prm_vname)
 Optionally declares a variable.
#define ae2f_SysInetMk(prm_VerReq, pret_WSAData)
 Wrapper of WSAStartup.
Does nothing on POSIX.
See ae2f_SysInetDel for cleanup.
#define ae2f_SysInetDel()
 Wrapper of WSACleanup
Cleanup library initialised by ae2f_SysInetMk.

Typedefs

typedef _ae2f_SysInetMkData ae2f_SysInetMkData

Enumerations

enum  ae2f_eSysInetMk {
  ae2f_SysInetMk_GOOD = 0 , ae2f_Sys_WIN =(= WSASYSNOTREADY) , ae2f_Sys_WIN =(= WSASYSNOTREADY) , ae2f_Sys_WIN =(= WSASYSNOTREADY) ,
  ae2f_Sys_WIN =(= WSASYSNOTREADY) , ae2f_Sys_WIN =(= WSASYSNOTREADY)
}
enum  ae2f_eSysInetDel { ae2f_SysInetDel_GOOD = 0 , ae2f_Sys_WIN =(= WSASYSNOTREADY) , ae2f_Sys_WIN =(= WSASYSNOTREADY) , ae2f_Sys_WIN =(= WSASYSNOTREADY) }

Detailed Description

Author
dalmurii

Definition in file Inet.h.

Macro Definition Documentation

◆ _ae2f_SysInetMkData

#define _ae2f_SysInetMkData
Value:
ae2f_Sys_WIN(ae2f_SysInetMkData_WIN)
ae2f_Sys_unused_t ae2f_SysInetMkData_POSIX
Dummy Inet API Data (Unused).
Definition Inet-POSIX.h:21
#define N_ae2f_Sys_WIN
Mutex is not owned by this thread.
Definition Sys.h:55

Definition at line 18 of file Inet.h.

◆ ae2f_SysInetDel

#define ae2f_SysInetDel ( )
Value:
ae2f_Sys_WIN(ae2f_SysInetDel_WIN()) \
N_ae2f_Sys_WIN(ae2f_SysInetDel_POSIX())
#define ae2f_SysInetDel_POSIX()
Dummy library release function.
Definition Inet-POSIX.h:39
#define ae2f_Sys_WIN
System does not support this version. <ae2f_SysInetMk::prm_VerReq>.
Definition Sys.h:18

Wrapper of WSACleanup
Cleanup library initialised by ae2f_SysInetMk.

Returns
ae2f_eSysInetDel
See also
ae2f_SysInetMk

Definition at line 138 of file Inet.h.

◆ ae2f_SysInetMk

#define ae2f_SysInetMk ( prm_VerReq,
pret_WSAData )
Value:
ae2f_Sys_WIN(ae2f_SysInetMk_WIN(prm_VerReq, pret_WSAData)) \
N_ae2f_Sys_WIN(ae2f_SysInetMk_POSIX(prm_VerReq, pret_WSAData))
#define ae2f_SysInetMk_POSIX(a, b)
Dummy library startup code. (Unused).
Definition Inet-POSIX.h:33

Wrapper of WSAStartup.
Does nothing on POSIX.
See ae2f_SysInetDel for cleanup.

You would be able to use POSIX inet functions(sockets) after this.

Returns
ae2f_eSysInetMk
Parameters
prm_VerReq<prm>
Type: const WORD
Brief: Required version of socket library.
See:
[out]pret_WSAData<opt> <ptr>
Type: ae2f_SysInetMkData_t*
Brief: Output pointer for winsocket data.
See also
ae2f_SysInetDel

Definition at line 125 of file Inet.h.

◆ ae2f_SysInetMkData_DEC

#define ae2f_SysInetMkData_DEC ( prm_vname)
Value:
ae2f_Sys_WIN(ae2f_SysInetMkData_DEC_WIN(prm_vname)) \
N_ae2f_Sys_WIN(ae2f_SysInetMkData_DEC_POSIX(prm_vname))
#define ae2f_SysInetMkData_DEC_POSIX(a)
Dummy ae2f_SysInetMkData_POSIX initialiser.
Definition Inet-POSIX.h:27

Optionally declares a variable.

Template Parameters
prm_vnameA name of the variable declared.
See also
ae2f_SysInetMk

Definition at line 97 of file Inet.h.

Typedef Documentation

◆ ae2f_SysInetMkData

typedef _ae2f_SysInetMkData ae2f_SysInetMkData

Definition at line 28 of file Inet.h.

Enumeration Type Documentation

◆ ae2f_eSysInetDel

Enumerator
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2

Definition at line 74 of file Inet.h.

◆ ae2f_eSysInetMk

Enumerator
ae2f_SysInetMk_GOOD 

Operation succeed.

ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
ae2f_Sys_WIN (= WSASYSNOTREADY) 

System is not ready.

Network is down.

Invalid pointer. <ae2f_SysInetMk::pret_WSAData>.

Exceeded Socket task limit.

Blocked by Windows Sockets 1.1 operations.

System does not support this version. <ae2f_SysInetMk::prm_VerReq>.

See also
https://learn.microsoft.com/en-us/windows/win32/winsock/windows-sockets-error-codes-2
ae2f_SysInetMk
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2
https://learn.microsoft.com/en-us/windows/desktop/WinSock/windows-sockets-error-codes-2

Definition at line 33 of file Inet.h.