Vanara/PInvoke/WebSocket/readme.md

43 lines
6.9 KiB
Markdown
Raw Normal View History

2022-10-30 16:01:59 -04:00
## Vanara.PInvoke.WebSocket
PInvoke API (methods, structures and constants) imported from the WebSocket API (WebSocket.dll).
- Includes methods from websocket.dll
- Current NuGet release: [![Nuget](https://img.shields.io/nuget/v/Vanara.PInvoke.WebSocket?logo=nuget&style=flat-square)![Nuget](https://img.shields.io/nuget/dt/Vanara.PInvoke.WebSocket?label=%20&style=flat-square)](https://www.nuget.org/packages/Vanara.PInvoke.WebSocket)
### Methods - 100% API coverage (13 of 13 functions)
Native Method | Header | Managed Method
--- | --- | ---
[WebSocketAbortHandle](https://www.google.com/search?num=5&q=WebSocketAbortHandle+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketAbortHandle](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketAbortHandle)
[WebSocketBeginClientHandshake](https://www.google.com/search?num=5&q=WebSocketBeginClientHandshake+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketBeginClientHandshake](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketBeginClientHandshake)
[WebSocketBeginServerHandshake](https://www.google.com/search?num=5&q=WebSocketBeginServerHandshake+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketBeginServerHandshake](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketBeginServerHandshake)
[WebSocketCompleteAction](https://www.google.com/search?num=5&q=WebSocketCompleteAction+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketCompleteAction](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketCompleteAction)
[WebSocketCreateClientHandle](https://www.google.com/search?num=5&q=WebSocketCreateClientHandle+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketCreateClientHandle](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketCreateClientHandle)
[WebSocketCreateServerHandle](https://www.google.com/search?num=5&q=WebSocketCreateServerHandle+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketCreateServerHandle](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketCreateServerHandle)
[WebSocketDeleteHandle](https://www.google.com/search?num=5&q=WebSocketDeleteHandle+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketDeleteHandle](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketDeleteHandle)
[WebSocketEndClientHandshake](https://www.google.com/search?num=5&q=WebSocketEndClientHandshake+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketEndClientHandshake](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketEndClientHandshake)
[WebSocketEndServerHandshake](https://www.google.com/search?num=5&q=WebSocketEndServerHandshake+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketEndServerHandshake](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketEndServerHandshake)
[WebSocketGetAction](https://www.google.com/search?num=5&q=WebSocketGetAction+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketGetAction](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketGetAction)
[WebSocketGetGlobalProperty](https://www.google.com/search?num=5&q=WebSocketGetGlobalProperty+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketGetGlobalProperty](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketGetGlobalProperty)
[WebSocketReceive](https://www.google.com/search?num=5&q=WebSocketReceive+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketReceive](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketReceive)
[WebSocketSend](https://www.google.com/search?num=5&q=WebSocketSend+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WebSocketSend](https://github.com/dahall/Vanara/search?l=C%23&q=WebSocketSend)
### Enumerations
Native Enum | Header | Managed Enum
--- | --- | ---
[WEB_SOCKET_ACTION](https://www.google.com/search?num=5&q=WEB_SOCKET_ACTION+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_ACTION](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_ACTION)
[WEB_SOCKET_ACTION_QUEUE](https://www.google.com/search?num=5&q=WEB_SOCKET_ACTION_QUEUE+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_ACTION_QUEUE](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_ACTION_QUEUE)
[WEB_SOCKET_BUFFER_TYPE](https://www.google.com/search?num=5&q=WEB_SOCKET_BUFFER_TYPE+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_BUFFER_TYPE](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_BUFFER_TYPE)
[WEB_SOCKET_CLOSE_STATUS](https://www.google.com/search?num=5&q=WEB_SOCKET_CLOSE_STATUS+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_CLOSE_STATUS](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_CLOSE_STATUS)
[WEB_SOCKET_PROPERTY_TYPE](https://www.google.com/search?num=5&q=WEB_SOCKET_PROPERTY_TYPE+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_PROPERTY_TYPE](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_PROPERTY_TYPE)
### Structures
Native Structure | Header | Managed Structure
--- | --- | ---
[CLOSESTATUS](https://www.google.com/search?num=5&q=CLOSESTATUS+site%3Alearn.microsoft.com) | | [Vanara.PInvoke.WebSocket.WEB_SOCKET_BUFFER.CLOSESTATUS](https://github.com/dahall/Vanara/search?l=C%23&q=CLOSESTATUS)
[DATA](https://www.google.com/search?num=5&q=DATA+site%3Alearn.microsoft.com) | | [Vanara.PInvoke.WebSocket.WEB_SOCKET_BUFFER.DATA](https://github.com/dahall/Vanara/search?l=C%23&q=DATA)
[WEB_SOCKET_BUFFER](https://www.google.com/search?num=5&q=WEB_SOCKET_BUFFER+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_BUFFER](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_BUFFER)
[WEB_SOCKET_HANDLE](https://www.google.com/search?num=5&q=WEB_SOCKET_HANDLE+site%3Alearn.microsoft.com) | | [Vanara.PInvoke.WebSocket.WEB_SOCKET_HANDLE](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_HANDLE)
[WEB_SOCKET_HTTP_HEADER](https://www.google.com/search?num=5&q=WEB_SOCKET_HTTP_HEADER+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_HTTP_HEADER](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_HTTP_HEADER)
[WEB_SOCKET_PROPERTY](https://www.google.com/search?num=5&q=WEB_SOCKET_PROPERTY+site%3Alearn.microsoft.com) | websocket.h | [Vanara.PInvoke.WebSocket.WEB_SOCKET_PROPERTY](https://github.com/dahall/Vanara/search?l=C%23&q=WEB_SOCKET_PROPERTY)
### Classes
Native Class | Header | Managed Class
--- | --- | ---
[SafeWEB_SOCKET_HANDLE](https://www.google.com/search?num=5&q=SafeWEB_SOCKET_HANDLE+site%3Alearn.microsoft.com) | | [Vanara.PInvoke.WebSocket.SafeWEB_SOCKET_HANDLE](https://github.com/dahall/Vanara/search?l=C%23&q=SafeWEB_SOCKET_HANDLE)