diff options
author | Simon Rozman <simon@rozman.si> | 2020-11-05 08:33:56 +0100 |
---|---|---|
committer | Simon Rozman <simon@rozman.si> | 2020-11-05 08:36:28 +0100 |
commit | abbf658211a3f25f2a97c14a2e15df988488873e (patch) | |
tree | 67369355dbbfa127df4e4c1115e12fbcf17c33d8 | |
parent | README: add reference and describe info (diff) | |
download | wintun-abbf658211a3f25f2a97c14a2e15df988488873e.tar.xz wintun-abbf658211a3f25f2a97c14a2e15df988488873e.zip |
api: fix typo in ring-management function prototype declarations
Signed-off-by: Simon Rozman <simon@rozman.si>
-rw-r--r-- | README.md | 10 | ||||
-rw-r--r-- | api/wintun.h | 10 |
2 files changed, 10 insertions, 10 deletions
@@ -310,7 +310,7 @@ Ends Wintun session. #### WintunGetReadWaitEvent() -`HANDLE WintunGetReadWaitEvent (WINTUN_SESSION_HANDLE * Session)` +`HANDLE WintunGetReadWaitEvent (WINTUN_SESSION_HANDLE Session)` 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() -`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. @@ -339,7 +339,7 @@ Pointer to layer 3 IPv4 or IPv6 packet. Client may modify its content at will. I #### 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. @@ -350,7 +350,7 @@ Releases internal buffer after the received packet has been processed by the cli #### 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. @@ -365,7 +365,7 @@ Returns pointer to memory where to prepare layer 3 IPv4 or IPv6 packet for sendi #### 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. diff --git a/api/wintun.h b/api/wintun.h index 13f908c..dd232fb 100644 --- a/api/wintun.h +++ b/api/wintun.h @@ -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 * 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 @@ -288,7 +288,7 @@ typedef HANDLE(WINAPI *WINTUN_GET_READ_WAIT_EVENT_FUNC)(_In_ WINTUN_SESSION_HAND * ERROR_INVALID_DATA Wintun buffer is corrupt */ 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. @@ -297,7 +297,7 @@ typedef _Return_type_success_(return != NULL) _Ret_bytecount_(*PacketSize) BYTE * * @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 @@ -315,7 +315,7 @@ typedef void(WINAPI *WINTUN_RECEIVE_RELEASE_FUNC)(_In_ WINTUN_SESSION_HANDLE *Se * ERROR_BUFFER_OVERFLOW Wintun buffer is full; */ 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 @@ -326,7 +326,7 @@ typedef _Return_type_success_(return != NULL) _Ret_bytecount_(PacketSize) BYTE * * * @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 } |