NetworkWebSocketClientConnectionInterface Class Reference | C4D R23.110 C++ SDK - 中文文档编制,帮助,手册,教程

公共成员函数 | 私有成员函数 | 所有成员列表

NetworkWebSocketClientConnectionInterface Class Reference

#include <network_websocket.h>

Inheritance diagram for NetworkWebSocketClientConnectionInterface:

Inheritance graph

[ legend ]

公共成员函数
MAXON_METHOD Result < DataDictionary >	OpenConnection (const String &address, const String &protocols, const CString &extraHeaderData, const ThreadRef &thread)

私有成员函数
	MAXON_INTERFACE ( NetworkWebSocketClientConnectionInterface , MAXON_REFERENCE_NORMAL , "net.maxon.interface.networkwebsocketclientconnection")
Private Member Functions inherited from NetworkWebSocketSignalInterface
	MAXON_OBSERVABLE ( Result < String >, ObservableHandshake,(const NetworkWebSocketConnectionRef &webSocket, const DataDictionary &request), ObservableCombinerRunAllComponent)
	MAXON_OBSERVABLE ( Result < void >, ObservableConnected,(const NetworkWebSocketConnectionRef &webSocket, const DataDictionary &request), ObservableCombinerRunAllComponent)
	MAXON_OBSERVABLE (void, ObservableDisconnected,(const NetworkWebSocketConnectionRef &webSocket), ObservableCombinerRunAllComponent)
	MAXON_OBSERVABLE (void, ObservableError,(const NetworkWebSocketConnectionRef &webSocket, const Error &err), ObservableCombinerRunAllComponent)
	MAXON_OBSERVABLE ( Result < void >, ObservableMessage,(const NetworkWebSocketConnectionRef &webSocket, WEBSOCKET_OPCODE opCode, const BaseArray < Char > &data), ObservableCombinerRunAllComponent)

成员函数文档编制

◆ MAXON_INTERFACE()

MAXON_INTERFACE	(	NetworkWebSocketClientConnectionInterface	,
		MAXON_REFERENCE_NORMAL	,
		"net.maxon.interface.networkwebsocketclientconnection"
	)

private

◆ OpenConnection()

MAXON_METHOD Result <DataDictionary> OpenConnection	(	const String &	address ,
		const String &	protocols ,
		const CString &	extraHeaderData ,
		const ThreadRef &	thread
	)

Start a client WebSocket connection to the given address e.g. "127.0.0.1:1234".

参数

[in]	address	Address of the server to connect.
[in]	protocols	Comma separated list of needed protocols e.g. "chat, superchat". The server picks on of the protocols for the communication.
[in]	extraHeaderData	Add extra data to the handshake header. A entry needs to be terminated by "\r\n". e.g. "id: data\r\nid2: data2\r\n"
[in]	thread	Thread reference that is checked for IsCancelled().

返回: Returns the http answer of the handshake.