Hesham/wintun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

api: fix typo in ring-management function prototype declarations

Browse Source 
Signed-off-by: Simon Rozman <simon@rozman.si>
This commit is contained in:
Simon Rozman 2020-11-05 08:33:56 +01:00
parent 317a91bcbe
commit abbf658211
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -310,7 +310,7 @@ Ends Wintun session.
#### WintunGetReadWaitEvent() #### WintunGetReadWaitEvent()
`HANDLE WintunGetReadWaitEvent (WINTUN_SESSION_HANDLE * Session)` `HANDLE WintunGetReadWaitEvent (WINTUN_SESSION_HANDLE Session)`
Gets Wintun session's read-wait event handle. Gets Wintun session's read-wait event handle.
@ -324,7 +324,7 @@ Pointer to receive event handle to wait for available data when reading. Should
#### WintunReceivePacket() #### WintunReceivePacket()
`BYTE* WintunReceivePacket (WINTUN_SESSION_HANDLE * Session, DWORD * PacketSize)` `BYTE* WintunReceivePacket (WINTUN_SESSION_HANDLE Session, DWORD * PacketSize)`
Retrieves one or packet. After the packet content is consumed, call WintunReceiveRelease with Packet returned from this function to release internal buffer. This function is thread-safe. Retrieves one or packet. After the packet content is consumed, call WintunReceiveRelease with Packet returned from this function to release internal buffer. This function is thread-safe.
@ -339,7 +339,7 @@ Pointer to layer 3 IPv4 or IPv6 packet. Client may modify its content at will. I
#### WintunReceiveRelease() #### WintunReceiveRelease()
`void WintunReceiveRelease (WINTUN_SESSION_HANDLE * Session, const BYTE * Packet)` `void WintunReceiveRelease (WINTUN_SESSION_HANDLE Session, const BYTE * Packet)`
Releases internal buffer after the received packet has been processed by the client. This function is thread-safe. Releases internal buffer after the received packet has been processed by the client. This function is thread-safe.
@ -350,7 +350,7 @@ Releases internal buffer after the received packet has been processed by the cli
#### WintunAllocateSendPacket() #### WintunAllocateSendPacket()
`BYTE* WintunAllocateSendPacket (WINTUN_SESSION_HANDLE * Session, DWORD PacketSize)` `BYTE* WintunAllocateSendPacket (WINTUN_SESSION_HANDLE Session, DWORD PacketSize)`
Allocates memory for a packet to send. After the memory is filled with packet data, call WintunSendPacket to send and release internal buffer. WintunAllocateSendPacket is thread-safe and the WintunAllocateSendPacket order of calls define the packet sending order. Allocates memory for a packet to send. After the memory is filled with packet data, call WintunSendPacket to send and release internal buffer. WintunAllocateSendPacket is thread-safe and the WintunAllocateSendPacket order of calls define the packet sending order.
@ -365,7 +365,7 @@ Returns pointer to memory where to prepare layer 3 IPv4 or IPv6 packet for sendi
#### WintunSendPacket() #### WintunSendPacket()
`void WintunSendPacket (WINTUN_SESSION_HANDLE * Session, const BYTE * Packet)` `void WintunSendPacket (WINTUN_SESSION_HANDLE Session, const BYTE * Packet)`
Sends the packet and releases internal buffer. WintunSendPacket is thread-safe, but the WintunAllocateSendPacket order of calls define the packet sending order. This means the packet is not guaranteed to be sent in the WintunSendPacket yet. Sends the packet and releases internal buffer. WintunSendPacket is thread-safe, but the WintunAllocateSendPacket order of calls define the packet sending order. This means the packet is not guaranteed to be sent in the WintunSendPacket yet.

10
api/wintun.h
View File

@ -265,7 +265,7 @@ typedef void(WINAPI *WINTUN_END_SESSION_FUNC)(_In_ WINTUN_SESSION_HANDLE Session
* load), wait for this event to become signaled before retrying WintunReceivePackets. Do not call * load), wait for this event to become signaled before retrying WintunReceivePackets. Do not call
* CloseHandle on this event - it is managed by the session. * CloseHandle on this event - it is managed by the session.
*/ */
typedef HANDLE(WINAPI *WINTUN_GET_READ_WAIT_EVENT_FUNC)(_In_ WINTUN_SESSION_HANDLE *Session); typedef HANDLE(WINAPI *WINTUN_GET_READ_WAIT_EVENT_FUNC)(_In_ WINTUN_SESSION_HANDLE Session);
/** /**
* Maximum IP packet size * Maximum IP packet size
@ -288,7 +288,7 @@ typedef HANDLE(WINAPI *WINTUN_GET_READ_WAIT_EVENT_FUNC)(_In_ WINTUN_SESSION_HAND
* ERROR_INVALID_DATA Wintun buffer is corrupt * ERROR_INVALID_DATA Wintun buffer is corrupt
*/ */
typedef _Return_type_success_(return != NULL) _Ret_bytecount_(*PacketSize) BYTE *( typedef _Return_type_success_(return != NULL) _Ret_bytecount_(*PacketSize) BYTE *(
WINAPI *WINTUN_RECEIVE_PACKET_FUNC)(_In_ WINTUN_SESSION_HANDLE *Session, _Out_ DWORD *PacketSize); WINAPI *WINTUN_RECEIVE_PACKET_FUNC)(_In_ WINTUN_SESSION_HANDLE Session, _Out_ DWORD *PacketSize);
/** /**
* Releases internal buffer after the received packet has been processed by the client. This function is thread-safe. * Releases internal buffer after the received packet has been processed by the client. This function is thread-safe.
@ -297,7 +297,7 @@ typedef _Return_type_success_(return != NULL) _Ret_bytecount_(*PacketSize) BYTE
* *
* @param Packet Packet obtained with WintunReceivePacket * @param Packet Packet obtained with WintunReceivePacket
*/ */
typedef void(WINAPI *WINTUN_RECEIVE_RELEASE_FUNC)(_In_ WINTUN_SESSION_HANDLE *Session, _In_ const BYTE *Packet); typedef void(WINAPI *WINTUN_RECEIVE_RELEASE_FUNC)(_In_ WINTUN_SESSION_HANDLE Session, _In_ const BYTE *Packet);
/** /**
* Allocates memory for a packet to send. After the memory is filled with packet data, call WintunSendPacket to send * Allocates memory for a packet to send. After the memory is filled with packet data, call WintunSendPacket to send
@ -315,7 +315,7 @@ typedef void(WINAPI *WINTUN_RECEIVE_RELEASE_FUNC)(_In_ WINTUN_SESSION_HANDLE *Se
* ERROR_BUFFER_OVERFLOW Wintun buffer is full; * ERROR_BUFFER_OVERFLOW Wintun buffer is full;
*/ */
typedef _Return_type_success_(return != NULL) _Ret_bytecount_(PacketSize) BYTE *( typedef _Return_type_success_(return != NULL) _Ret_bytecount_(PacketSize) BYTE *(
WINAPI *WINTUN_ALLOCATE_SEND_PACKET_FUNC)(_In_ WINTUN_SESSION_HANDLE *Session, _In_ DWORD PacketSize); WINAPI *WINTUN_ALLOCATE_SEND_PACKET_FUNC)(_In_ WINTUN_SESSION_HANDLE Session, _In_ DWORD PacketSize);
/** /**
* Sends the packet and releases internal buffer. WintunSendPacket is thread-safe, but the WintunAllocateSendPacket * Sends the packet and releases internal buffer. WintunSendPacket is thread-safe, but the WintunAllocateSendPacket
@ -326,7 +326,7 @@ typedef _Return_type_success_(return != NULL) _Ret_bytecount_(PacketSize) BYTE *
* *
* @param Packet Packet obtained with WintunAllocateSendPacket * @param Packet Packet obtained with WintunAllocateSendPacket
*/ */
typedef void(WINAPI *WINTUN_SEND_PACKET_FUNC)(_In_ WINTUN_SESSION_HANDLE *Session, _In_ const BYTE *Packet); typedef void(WINAPI *WINTUN_SEND_PACKET_FUNC)(_In_ WINTUN_SESSION_HANDLE Session, _In_ const BYTE *Packet);
#ifdef __cplusplus #ifdef __cplusplus
} }