WEB_SOCKET_ACTION enumeration (websocket.h)

  • Article

The WEB_SOCKET_ACTION enumeration specifies actions to be taken by WebSocket applications.

Syntax

typedef enum _WEB_SOCKET_ACTION {
  WEB_SOCKET_NO_ACTION = 0,
  WEB_SOCKET_SEND_TO_NETWORK_ACTION = 1,
  WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION = 2,
  WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION = 3,
  WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION = 4
} WEB_SOCKET_ACTION, *PWEB_SOCKET_ACTION;

Constants

 
WEB_SOCKET_NO_ACTION
Value: 0
There are no actions to process.
WEB_SOCKET_SEND_TO_NETWORK_ACTION
Value: 1
Indicates the application should send the buffers to a network.
WEB_SOCKET_INDICATE_SEND_COMPLETE_ACTION
Value: 2
Indicates the operation queued by WebSocketSend is complete. The application context returned by WebSocketCompleteAction for this send operation is no longer needed, therefore it should be freed.
WEB_SOCKET_RECEIVE_FROM_NETWORK_ACTION
Value: 3
Indicates the application should fill the buffers with data from a network.
WEB_SOCKET_INDICATE_RECEIVE_COMPLETE_ACTION
Value: 4
Indicates the operation queued by WebSocketReceive is complete. The application context returned by WebSocketCompleteAction for this receive operation is no longer needed, therefore it should be freed.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Header websocket.h

See also

WEB_SOCKET_ACTION_QUEUE

WebSocketCompleteAction

WebSocketGetAction

WebSocketReceive

WebSocketSend