WebSocket_Connect


Connects to a remote server using WebSocket protocol.

Syntax

C++
C#
Python
 
def WebSocket_Connect(
	state: WebSocketConnectionState,
	inHostName: str,
	/,
	*,
	inTimeout: int | None = None,
	inReadBufferSize: int | None = None,
	inAllowUntrusted: bool = False,
	inCaCertFile: str | None = None
)
-> outWebSocket: int | None

Parameters

Name Type Range Default Description
Input will be modified ioState WebSocketConnectionState
Input value inHostName str URL address of the remote server.
Input value inTimeout int | None 0 - None Request timeout in seconds.
Input value inReadBufferSize int | None None Read buffer size.
Input value inAllowUntrusted bool False Whether or not to allow untrusted SSL certificates.
Input value inCaCertFile str | None None File holding one or more certificates to verify the peer with.
Output value outWebSocket int | None Connected socket ID.