Back to Aurora Vision Library website

You are here: Start » Function Reference » System » WebSocket » WebSocket_Connect

WebSocket_Connect


Header: AVL.h
Namespace: avl
Module: FoundationBasic

Connects to a remote server using WebSocket protocol.

Syntax

C++
C#
 
void avl::WebSocket_Connect
(
	avl::WebSocketConnectionState& ioState,
	const atl::String& inHostName,
	atl::Optional<int> inTimeout,
	atl::Optional<int> inReadBufferSize,
	bool inAllowUntrusted,
	const atl::Optional<atl::File>& inCaCertFile,
	atl::Conditional<avl::WebSocketId>& outWebSocket
)

Parameters

Name Type Range Default Description
Input will be modified ioState WebSocketConnectionState& Object used to maintain state of the function.
Input value inHostName const String& \"ws://\" URL address of the remote server.
Input value inTimeout Optional<int> 0 - NIL Request timeout in seconds.
Input value inReadBufferSize Optional<int> NIL Read buffer size.
Input value inAllowUntrusted bool False Whether or not to allow untrusted SSL certificates.
Input value inCaCertFile const Optional<File>& NIL File holding one or more certificates to verify the peer with.
Output value outWebSocket Conditional<WebSocketId>& Connected socket ID.