WebSocketConnectionDataToSend Property

This property contains a string of data to be sent to the remote host.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int SetWebSocketConnectionDataToSend(int iConnectionId, const char* lpWebSocketConnectionDataToSend, int lenWebSocketConnectionDataToSend);

Unicode (Windows)
INT SetWebSocketConnectionDataToSend(INT iConnectionId, LPCSTR lpWebSocketConnectionDataToSend, INT lenWebSocketConnectionDataToSend);

- (NSString*)webSocketConnectionDataToSend:(int)connectionId;
- (void)setWebSocketConnectionDataToSend:(int)connectionId:(NSString*)newWebSocketConnectionDataToSend;

- (NSData*)webSocketConnectionDataToSendB:(int)connectionId;
- (void)setWebSocketConnectionDataToSendB:(int)connectionId:(NSData*)newWebSocketConnectionDataToSend;

#define PID_WEBSOCKETSERVER_WEBSOCKETCONNECTIONDATATOSEND 8


IPWORKSWS_EXTERNAL int IPWORKSWS_CALL IPWorksWS_WebSocketServer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSWS_EXTERNAL int IPWORKSWS_CALL IPWorksWS_WebSocketServer_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

Remarks

This property contains a string of data to be sent to the remote host. Write-only property.

Assigning a string to the WebSocketConnectionDataToSend makes the class send the string to the remote host. The Send method provides similar functionality.

If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, DataToSend fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again. (However, please note that ReadyToSend is not fired when part of the data is successfully sent).

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 write-only and not available at design time.

Data Type

Binary String