DataFormat Property
The format of the data being sent.
Syntax
ANSI (Cross Platform) int GetDataFormat();
int SetDataFormat(int iDataFormat); Unicode (Windows) INT GetDataFormat();
INT SetDataFormat(INT iDataFormat);
Possible Values
DF_AUTOMATIC(0),
DF_TEXT(1),
DF_BINARY(2),
DF_PING(9),
DF_PONG(10)
@property (nonatomic,readwrite,assign,getter=dataFormat,setter=setDataFormat:) int dataFormat; - (int)dataFormat; - (void)setDataFormat:(int)newDataFormat;
Possible Values
DF_AUTOMATIC(0),
DF_TEXT(1),
DF_BINARY(2),
DF_PING(9),
DF_PONG(10)
#define PID_WEBSOCKETCLIENT_DATAFORMAT 13 IPWORKSWS_EXTERNAL void* IPWORKSWS_CALL IPWorksWS_WebSocketClient_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKSWS_EXTERNAL int IPWORKSWS_CALL IPWorksWS_WebSocketClient_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
Default Value
0
Remarks
When data is sent over an established connection it is usually considered as text or binary data. Text data is UTF-8 encoded. Binary data has no encoding associated with it.
Possible values are:
| 0 (dfAutomatic - default) | The class will attempt to automatically determine the correct data format. This is suitable for most cases. |
| 1 (dfText) | The class will UTF-8 encode the specified data before sending. Data that has already been UTF-8 encoded may also be supplied. |
| 2 (dfBinary) | The class will send the data exactly as it is provided. |
| 9 (dfPing) | The class will send the ping with data exactly as it is provided. |
| 10 (dfPong) | The class will send the pong with data exactly as it is provided. |
Data Type
Integer