WebSocketConnectionReadyToSend Property

Indicates whether the class is ready to send data.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetWebSocketConnectionReadyToSend(int iConnectionId);

Unicode (Windows)
BOOL GetWebSocketConnectionReadyToSend(INT iConnectionId);

- (BOOL)webSocketConnectionReadyToSend:(int)connectionId;

#define PID_WEBSOCKETSERVER_WEBSOCKETCONNECTIONREADYTOSEND 12

IPWORKSWS_EXTERNAL void* IPWORKSWS_CALL IPWorksWS_WebSocketServer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

IPWORKSWS_EXTERNAL int IPWORKSWS_CALL IPWorksWS_WebSocketServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

FALSE

Remarks

Indicates whether the class is ready to send data.

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects, and will become False after a failed WebSocketConnectionDataToSend.

After a failed WebSocketConnectionDataToSend the ReadyToSend event will fire and this property will be True when data can be sent again.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WebSocketConnectionCount property.

This property is read-only and not available at design time.

Data Type

Boolean