You are here: Start » FIL.NET » Invoke.WebSocket_Connect

Invoke.WebSocket_Connect

Connects to a remote server using WebSocket protocol.

Namespace:Fil
Assembly:FilNet.dll

Syntax

C++
C#
 
public static void WebSocket_Connect
(
	Fil.WebSocketConnectionState ioState,
	string inHostName,
	Optional<int> inTimeout,
	Optional<int> inReadBufferSize,
	bool inAllowUntrusted,
	Optional<string> inCaCertFile,
	Conditional<int> outWebSocket
)

Parameters

Name Type Range Default Description
ioStateFil.WebSocketConnectionState
inHostNamestring\"ws://\"URL address of the remote server. Default value: "ws://".
inTimeoutFtl.Optional<int><0, INF>Request timeout in seconds. Default value: ftl::NIL.
inReadBufferSizeFtl.Optional<int>Read buffer size. Default value: ftl::NIL.
inAllowUntrustedboolFalseWhether or not to allow untrusted SSL certificates. Default value: False.
inCaCertFileFtl.Optional<string>File holding one or more certificates to verify the peer with. Default value: ftl::NIL.
outWebSocketFtl.Conditional<int>Connected socket ID.

See also