IPWorks WebSockets 2020 PHP Edition

Questions / Feedback?

WebSocketConnectionDataFormat Property

The format of the data being sent.

Object Oriented Interface

public function getWebSocketConnectionDataFormat($connectionid);
public function setWebSocketConnectionDataFormat($connectionid, $value);

Procedural Interface

ipworksws_websocketserver_get($res, 7 , $connectionid);
ipworksws_websocketserver_set($res, 7, $value , $connectionid);

Default Value

0

Remarks

The format of the data being sent. When data is sent over an established connection it is either 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.

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

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 PHP Edition - Version 20.0 [Build 8155]