Socket methods syntax

From m204wiki
Revision as of 21:24, 14 June 2012 by JALWiccan (talk | contribs) (Automatically generated page update)
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:CertInfo( string, [number])

%number = socket:CertLevels

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

[%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

[%number =] socket:SSLOn

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

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

%socket = [%(Socket):]ServerSocket

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

%string = socket:TranIn( string)

%string = socket:TranOut( string)

%string = socket:URLEncode( string)