Socket methods syntax

From m204wiki
Revision as of 17:24, 12 August 2019 by DmeWiccan (talk | contribs) (Automatically generated page update)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The syntax for each of the Socket class methods is shown below.

Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of Socket methods.

[%string =] socket:Capture( string)

%string = socket:Certificate[( [RequestCertificate= boolean])]

%string = socket:CertInfo( string, [number])

%number = socket:CertLevels

[%number =] socket:Close

%string = %(Socket):ErrInfo( string)

%number = socket:GetSocketNumber

%socket = [%(Socket):]GetSocketObject( number)

%string = socket:Info( string)

%socket = [%(Socket):]New[( [[ClientPort=] string], [[Host=] string], - [[Port=] number], [[SSL=] string], - [TcpKeepAlive= boolean])]

%string = %(Socket):Num[( [string])]

[%number =] %(Socket):OnReset[( [label])]

%bytesReceived = socket:Receive( [Target=] string, [[MaxBytes=] number], - [[MinBytes=] number], [[Options=] string])

%bytesReceived = socket:ReceiveAndParse( [Target=] string, - [[MaxBytes=] number], - [[ParseTokenIndex=] number], - [[Options=] string])

%bytesReceived = socket:ReceiveAsynchronous( [Target=] string, - [[MaxBytes=] number], - [[Options=] string], - [Wait= boolean])

%receivedFin = socket:ReceivedFin

%opCode = socket:ReceiveWebSocket( string)

[%number =] socket:Send( string, [[Options=] string])

[%number =] socket:SendWebSocket( string, number, boolean)

[%number =] socket:SendWithLineEnd( string, [[Options=] string])

%socket = [%(Socket):]ServerSocket

[%string =] socket:Set( keyword, [value])

[%number =] socket:SSLOn

%string = socket:TranIn( string)

%string = socket:TranOut( string)

%string = socket:URLEncode( string)

%socket = [%(Socket):]WebSocket