Notes="Begins establishing a (client) TCP connection to the specified host. Uses the LinkCallbacks table to report progress, success, errors and incoming data. Returns false if it fails immediately (bad port value, bad hostname format), true otherwise. Host can be either an IP address or a hostname.",
},
CreateUDPEndpoint=
{
IsStatic=true,
Params=
{
{
Name="Port",
Type="number",
},
{
Name="UDPCallbacks",
Type="table",
},
},
Returns=
{
{
Type="cUDPEndpoint",
},
},
Notes="Creates a UDP endpoint that listens for incoming datagrams on the specified port, and can be used to send or broadcast datagrams. Uses the UDPCallbacks to report incoming datagrams or errors. If the endpoint cannot be created, the OnError callback is called with the error details and the returned endpoint will report IsOpen() == false. The plugin needs to store the returned endpoint object for as long as it needs the UDP port open; if the endpoint is garbage-collected by Lua, the socket will be closed and no more incoming data will be reported.<br>If the Port is zero, the OS chooses an available UDP port for the endpoint; use {{cUDPEndpoint}}:GetPort() to query the port number in such case.",
},
EnumLocalIPAddresses=
{
IsStatic=true,
Returns=
{
{
Type="table",
},
},
Notes="Returns all local IP addresses for network interfaces currently available on the machine, as an array-table of strings.",
},
HostnameToIP=
{
IsStatic=true,
Params=
{
{
Name="Host",
Type="string",
},
{
Name="LookupCallbacks",
Type="table",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Begins a DNS lookup to find the IP address(es) for the specified host. Uses the LookupCallbacks table to report progress, success or errors. Returns false if it fails immediately (bad hostname format), true if the lookup started successfully. Host can be either a hostname or an IP address.",
},
IPToHostname=
{
IsStatic=true,
Params=
{
{
Name="Address",
Type="string",
},
{
Name="LookupCallbacks",
Type="table",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Begins a reverse-DNS lookup to find out the hostname for the specified IP address. Uses the LookupCallbacks table to report progress, success or errors. Returns false if it fails immediately (bad address format), true if the lookup started successfully.",
},
Listen=
{
IsStatic=true,
Params=
{
{
Name="Port",
Type="number",
},
{
Name="ListenCallbacks",
Type="table",
},
},
Returns=
{
{
Type="cServerHandle",
},
},
Notes="Starts listening on the specified port. Uses the ListenCallbacks to report incoming connections or errors. Returns a {{cServerHandle}} object representing the server. If the listen operation failed, the OnError callback is called with the error details and the returned server handle will report IsListening() == false. The plugin needs to store the server handle object for as long as it needs the server running, if the server handle is garbage-collected by Lua, the listening socket will be closed and all current connections dropped.",
Notes="Closes the link forcefully (TCP RST). There's no guarantee that the last sent data is even being delivered. See also the Shutdown() method.",
},
GetLocalIP=
{
Returns=
{
{
Type="string",
},
},
Notes="Returns the IP address of the local endpoint of the TCP connection.",
},
GetLocalPort=
{
Returns=
{
{
Type="number",
},
},
Notes="Returns the port of the local endpoint of the TCP connection.",
},
GetRemoteIP=
{
Returns=
{
{
Type="string",
},
},
Notes="Returns the IP address of the remote endpoint of the TCP connection.",
},
GetRemotePort=
{
Returns=
{
{
Type="number",
},
},
Notes="Returns the port of the remote endpoint of the TCP connection.",
},
Send=
{
Params=
{
{
Name="Data",
Type="string",
},
},
Notes="Sends the data (raw string) to the remote peer. The data is sent asynchronously and there is no report on the success of the send operation, other than the connection being closed or reset by the underlying OS.",
},
Shutdown=
{
Notes="Shuts the socket down for sending data. Notifies the remote peer that there will be no more data coming from us (TCP FIN). The data that is in flight will still be delivered. The underlying socket will be closed when the remote end shuts down as well, or after a timeout.",
},
StartTLSClient=
{
Params=
{
{
Name="OwnCert",
Type="string",
},
{
Name="OwnPrivateKey",
Type="string",
},
{
Name="OwnPrivateKeyPassword",
Type="string",
},
},
Returns=
{
{
Name="IsSuccess",
Type="boolean",
},
{
Name="ErrorMessage",
Type="string",
IsOptional=true,
},
},
Notes="Starts a TLS handshake on the link, as a client side of the TLS. The Own___ parameters specify the client certificate and its corresponding private key and password; all three parameters are optional and no client certificate is presented to the remote peer if they are not used or all empty. Once the TLS handshake is started by this call, all incoming data is first decrypted before being sent to the OnReceivedData callback, and all outgoing data is queued until the TLS handshake completes, and then sent encrypted over the link. Returns true on success, nil and optional error message on immediate failure.<br/><b>NOTE:</b> The TLS support in the API is currently experimental and shouldn't be considered safe - there's no peer certificate verification and the error reporting is only basic.",
},
StartTLSServer=
{
Params=
{
{
Name="Certificate",
Type="string",
},
{
Name="PrivateKey",
Type="string",
},
{
Name="PrivateKeyPassword",
Type="string",
},
{
Name="StartTLSData",
Type="string",
},
},
Returns=
{
{
Name="IsSuccess",
Type="boolean",
},
{
Name="ErrorMessage",
Type="string",
IsOptional=true,
},
},
Notes="Starts a TLS handshake on the link, as a server side of the TLS. The plugin needs to specify the server certificate and its corresponding private key and password. The StartTLSData can contain data that the link has already reported as received but it should be used as part of the TLS handshake. Once the TLS handshake is started by this call, all incoming data is first decrypted before being sent to the OnReceivedData callback, and all outgoing data is queued until the TLS handshake completes, and then sent encrypted over the link. Returns true on success, nil and optional error message on immediate failure.<br/><b>NOTE:</b> The TLS support in the API is currently experimental and shouldn't be considered safe - there's no peer certificate verification and the error reporting is only basic.",
Represents a UDP socket that is listening for incoming datagrams on a UDP port and can send or broadcast datagrams to other peers on the network. Plugins can create an instance of the endpoint by calling {{cNetwork}}:CreateUDPEndpoint(). The endpoints are callback-based - when a datagram is read from the network, the OnRececeivedData() callback is called with details about the datagram. See the additional information in {{cNetwork}} documentation for details.</p>
Note that when Lua garbage-collects this class, the listening socket is closed. Therefore the plugin should keep this object referenced in a global variable for as long as it wants the endpoint open.
Notes="Closes the UDP endpoint. No more datagrams will be reported through the callbacks, the UDP port will be closed.",
},
EnableBroadcasts=
{
Notes="Some OSes need this call before they allow UDP broadcasts on an endpoint.",
},
GetPort=
{
Returns=
{
{
Type="number",
},
},
Notes="Returns the local port number of the UDP endpoint listening for incoming datagrams. Especially useful if the UDP endpoint was created with auto-assign port (0).",
},
IsOpen=
{
Returns=
{
{
Type="boolean",
},
},
Notes="Returns true if the UDP endpoint is listening for incoming datagrams.",
},
Send=
{
Params=
{
{
Name="RawData",
Type="string",
},
{
Name="RemoteHost",
Type="string",
},
{
Name="RemotePort",
Type="number",
},
},
Returns=
{
{
Type="boolean",
},
},
Notes="Sends the specified raw data (string) to the specified remote host. The RemoteHost can be either a hostname or an IP address; if it is a hostname, the endpoint will queue a DNS lookup first, if it is an IP address, the send operation is executed immediately. Returns true if there was no immediate error, false on any failure. Note that the return value needn't represent whether the packet was actually sent, only if it was successfully queued.",
Notes="Starts a HTTP DELETE request. Alias for Request(\"DELETE\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
},
{
IsStatic=true,
Params=
{
{
Name="URL",
Type="string",
},
{
Name="Callbacks",
Type="function",
},
},
Returns=
{
{
Name="IsSuccess",
Type="boolean",
},
{
Name="ErrorMessagge",
Type="string",
IsOptional=true,
},
},
Notes="Starts a HTTP DELETE request. Alias for Request(\"DELETE\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
Notes="Starts a HTTP GET request. Alias for Request(\"GET\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
},
{
IsStatic=true,
Params=
{
{
Name="URL",
Type="string",
},
{
Name="Callbacks",
Type="function",
},
},
Returns=
{
{
Name="IsSuccess",
Type="boolean",
},
{
Name="ErrMsg",
Type="string",
IsOptional=true,
},
},
Notes="Starts a HTTP GET request. Alias for Request(\"GET\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
Notes="Starts a HTTP POST request. Alias for Request(\"POST\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
},
{
IsStatic=true,
Params=
{
{
Name="URL",
Type="string",
},
{
Name="Callbacks",
Type="function",
},
},
Returns=
{
{
Name="IsSuccess",
Type="boolean",
},
{
Name="ErrMsg",
Type="string",
IsOptional=true,
},
},
Notes="Starts a HTTP POST request. Alias for Request(\"POST\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
Notes="Starts a HTTP PUT request. Alias for Request(\"PUT\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
},
{
IsStatic=true,
Params=
{
{
Name="URL",
Type="string",
},
{
Name="Callbacks",
Type="function",
},
},
Returns=
{
{
Name="IsSuccess",
Type="boolean",
},
{
Name="ErrMsg",
Type="string",
IsOptional=true,
},
},
Notes="Starts a HTTP PUT request. Alias for Request(\"PUT\", ...). Returns true on succes, false and error message on immediate failure (unparsable URL etc.).",
<tr><td>OnConnected</td><td>self, {{cTCPLink}}, RemoteIP, RemotePort</td><td>Called when the connection to the remote host is established. <i>Note that current implementation doesn't provide the {{cTCPLink}} parameter and passes nil instead.</i></td></tr>
<tr><td>OnCertificateReceived</td><td>self</td><td>Called for HTTPS URLs when the server's certificate is received. If the callback returns anything else than true, the connection is aborted. <i>Note that the current implementation doesn't provide the certificate because there is no representation for the cert in Lua.</i></td></tr>
<tr><td>OnTlsHandshakeCompleted</td><td>self</td><td>Called for HTTPS URLs when the TLS is established on the connection.</td></tr>
<tr><td>OnRequestSent</td><td>self</td><td>Called after the entire request is sent to the server.</td></tr>
<tr><td>OnStatusLine</td><td>self, HttpVersion, StatusCode, Rest</td><td>The initial line of the response has been parsed. HttpVersion is typically "HTTP/1.1", StatusCode is the numerical HTTP status code reported by the server (200 being OK), Rest is the rest of the line, usually a short message in case of an error.</td></tr>
<tr><td>OnHeader</td><td>self, Name, Value</td><td>A new HTTP response header line has been received.</td></tr>
<tr><td>OnHeadersFinished</td><td>self, AllHeaders</td><td>All HTTP response headers have been parsed. AllHeaders is a dictionary-table containing all the headers received.</td></tr>
<tr><td>OnBodyData</td><td>self, Data</td><td>A piece of the response body has been received. This callback is called repeatedly until the entire body is reported through its Data parameter.</td></tr>
<tr><td>OnBodyFinished</td><td>self</td><td>The entire response body has been reported by OnBodyData(), the response has finished.</td></tr>
<tr><td>OnError</td><td>self, ErrorMsg</td><td>Called whenever an error is detected. After this call, no other callback will get called.</td></tr>
<tr><td>OnRedirecting</td><td>self, NewUrl</td><td>Called if the server returned a valid redirection HTTP status code and a Location header, and redirection is allowed by the Options.</td></tr>
</table>
<p>
The following example is adapted from the Debuggers plugin's "download" command, it downloads the
contents of an URL into a file.
<pre class="prettyprint lang-lua">
function HandleConsoleDownload(a_Split) -- Console command handler
The requests support the following options, specified in the optional Options table parameter:
<table>
<tr><th>Option name</th><th>Description</th></tr>
<tr><td>MaxRedirects</td><td>Maximum number of HTTP redirects that the cUrlClient will follow. If the server still reports a redirect after reaching this many redirects, the cUrlClient reports an error. May be specified as either a number or a string parsable into a number. Default: 30.</td></tr>
<tr><td>OwnCert</td><td>The client certificate to use, if requested by the server. A string containing a PEM- or DER-encoded cert is expected.</td></tr>
<tr><td>OwnPrivKey</td><td>The private key appropriate for OwnCert. A string containing a PEM- or DER-encoded private key is expected.</td></tr>
<tr><td>OwnPrivKeyPassword</td><td>The password for OwnPrivKey. If not present or empty, no password is assumed.</td></tr>
</table>
<p>
Redirection:
<ul>
<li>If a redirect is received, and redirection is allowed by MaxRedirects, the redirection is
reported via OnRedirecting() callback and the request is restarted at the redirect URL, without
reporting any of the redirect's headers nor body.</li>
<li>If a redirect is received and redirection is not allowed (maximum redirection attempts have
been reached), the OnRedirecting() callback is called with the redirect URL and then the request
terminates with an OnError() callback, without reporting the redirect's headers nor body.</li>
