Networking Protocols and Named Pipes¶

Creating net_tcp Objects¶

type net_tcp¶

net_tcp()

net_tcp(fd::filedesc)

A net_tcp object is created with no parameters. Once an object is obtained it can be used to open or accept TCP connections. Alternatively, can be passed a filedesc object that it will use to read and write data.

Opening TCP Connections¶

net_tcp->connect(to::string, port::integer, timeout::integer=4)¶

Opens a TCP connection to the indicated server. TCP connections are made based on an address string and a port number. A server must be listening at the address and port before connections can be made to it. The address can be either a host name or an IP address. The addresses “0.0.0.0” or “127.0.0.1” can be used for local connections.

If the connection succeeds this method will return “true”, otherwise it returns “false”. The method does not cause a failure if the connection cannot be made. By default, this method will timeout after 4 seconds and return “false” if a connection cannot be made. It will return faster than that in cases where the indicated server is not on the network or has no server listening on the indicated port. This timeout is more likely to be hit when connecting to a server that is available but under heavy load and not processing new connections in a timely manner. This timeout value can be tailored for the expected network conditions. A value of “-1” indicates no timeout.

Accepting TCP Connections¶

A TCP server listens on a specific port for client connections. Once a client connects, a new net_tcp object is returned for that connection. There are several steps for establishing a server. The series of methods is generally: bind, listen and then either accept or forEachAccept.

net_tcp->bind(port::integer, address::string='0.0.0.0')¶

net_tcp->listen(backlog::integer=128)¶

When acting as a server, the net_tcp object must first be bound to a local port and optional address. The address can be ignored in most cases, but is useful on machines that have multiple network interfaces. The bind can be called before a client connection is made as well, however the operating system will automatically bind a client connection to a random port if it is not already bound, so binding a client connection is usually skipped.

When creating a server, listen is called after bind. This method allows the new object to begin accepting client connections.

net_tcp->accept(timeoutSeconds::integer=-1)¶

net_tcp->forEachAccept()¶

After a net_tcp object has been bound and is listening, client connections can then be accepted. The accept method is called to accept one connection. The process of accepting a connection does not actually establish a connection; instead, a new object is returned for that connection. Usually, the new connection should be passed to the new thread. This permits the server’s thread to continue accepting new connections in a loop while the newly accepted connection is free to handle itself independently.

By default, accept will wait forever for a client to connect. The timeout parameter can be used to have the call return null if no client has connected in that period.

The forEachAccept method is used to accept connections in a loop. This method is called and given a capture. Each accepted connection will be passed to that capture to be handled.

Closing TCP Connections¶

net_tcp->close()¶

TCP connections should be closed as soon as they are no longer needed. Once a net_tcp object has been closed it should not be used again.

net_tcp->shutdownRd()¶

net_tcp->shutdownWr()¶

net_tcp->shutdownRdWr()¶

These methods give greater control over closing the connection at the TCP level. Respectively, these methods close down communications channels for the read, write, or read and write directions. A close should still be called after a shutdown.

Reading TCP Data¶

net_tcp->readSomeBytes(count::integer, timeoutSeconds::integer)¶

Attempts to read up to the indicated number of bytes. If any bytes are immediately available then those will be returned and may be fewer than the requested amount. The timeout parameter controls how long the method will wait for data if there is none to be read. The method will return “null” if the timeout is reached.

Writing TCP Data¶

net_tcp->writeBytes(data::bytes, offset::integer=0, length::integer=-1)¶

Attempts to send the indicated bytes. An optional zero-based offset parameter indicates how far in the bytes to skip before sending. An optional length parameter indicates how many bytes to sent. The default value of “-1” indicates that all the bytes should be sent.

This method returns the number of bytes that were sent. However, this number will always match the number of bytes requested to be sent. This method automatically handles TCP flow control, but does not accept a timeout value.

Simple Multi-Threaded Server¶

The example below creates a simple server that returns an HTTP response that simply echos back the request data it received.

local(server) = net_tcp
handle => { #server->close }

#server->bind(8080) & listen & forEachAccept => {
   // New client connection
   local(con) = #1

   // Move connection into new thread
   split_thread => {
      handle => { #con->close }
      local(request) = ''

      // Read in the entire request in chunks
      {
         #request->append(#con->readSomeBytes(8096))
         not #request->contains('\r\n\r\n') ? currentCapture->restart
      }()

      // Write out the HTTP response with the request in the body
      local(response) = 'HTTP/1.1 200 OK\r\n\
            Content-Type: text/html; charset=UTF-8\r\n\r\n\
            ' + #request
      #con->writeBytes(bytes(#response))
   }
}

While that server was running, if you were to open up a terminal shell on the same machine and execute curl localhost:8080, the following would be the result:

$> curl localhost:8080
GET / HTTP/1.1
User-Agent: curl/7.30.0
Host: localhost:8080
Accept: */*

Creating net_tcp_ssl Objects¶

type net_tcp_ssl¶

Changed in version 9.2.6: Renamed from net_tcpssl.

net_tcp_ssl()

net_tcp_ssl(fd::filedesc)

The first method creates and returns a new net_tcp_ssl object and accepts no parameters. The second creator method can be passed a filedesc object that will use to read and write data.

Loading SSL Certificates¶

net_tcp_ssl->loadCerts(cert::string, privateKey::string)¶

Accepts the file paths to a certificate file and a private key file. This method is required when creating a TCP SSL server. The paths should be full OS-specific paths to the files. This method calls through to the OpenSSL functions SSL_CTX_use_certificate_chain_file and SSL_CTX_use_PrivateKey_file. This method will fail if an error is returned from the OpenSSL functions, in which case the OpenSSL-specific error code and message will be set.

Beginning and Ending SSL Sessions¶

net_tcp_ssl->beginTLS(timeoutSecs::integer=5)¶

Begins SSL communications for the connection. Because starting SSL requires a series of communications between the two hosts, this method accepts a timeout parameter which will terminate the action if it takes too long to complete.

This method returns no value, but will fail if the underlying OpenSSL library produces an error.

net_tcp_ssl->endTLS()¶

Ends the SSL session and returns the connection to its non-SSL state. The connection is not terminated in any way.

Accepting SSL Connections¶

Accepting SSL connections is accomplished in the same manner as accepting non-SSL connections. However, serving SSL requires setting the certificate and private key files through the net_tcp_ssl->loadCerts method.

The net_tcp_ssl object supports both accept and forEachAccept just as net_tcp does. Accepting a connection using either of those methods will return a net_tcp_ssl object that has started the SSL session. Because some protocols require connections to be established first and then switched to SSL, net_tcp_ssl also provides an acceptNoSSL method.

net_tcp_ssl->acceptNoSSL(timeoutSeconds::integer=-1) → net_tcp_ssl¶

Accepts a new connection and returns a net_tcp_ssl object for it. This connection has not yet started an SSL session and operates just as a net_tcp connection would. SSL can be started via the net_tcp_ssl->beginTLS method.

Creating net_udp Objects¶

type net_udp¶

net_udp()

net_udp(fd::filedesc)

The first method accepts no parameters and returns a new net_udp object. Alternatively, a filedesc object that will be used to read and write data can be passed as a parameter.

Reading UDP Data¶

Reading UDP data requires first binding a net_udp object to a specific port and optional address. Once bound, data can be read through the net_udp->readPacket method which returns data as an object of type net_udp_packet. This contains the bytes sent as well as the address of the sender and the port from which it was sent.

net_udp->readPacket(maxBytes::integer, timeoutSeconds::integer=-1)¶

Waits to receive a new UDP packet. The “maxBytes” parameter indicates the maximum size of data to receive. The number of bytes returned may be fewer than indicated, though individual packets will not be segmented. This value affects the size of the memory buffer allocated internally to hold incoming data.

The timeout parameter indicates how long the method should wait before returning a “null” value. The default value of “-1” indicates that the method should wait forever.

When successful, this method returns a net_udp_packet object.

type net_udp_packet¶

net_udp_packet(bytes, name, port)

net_udp_packet->bytes() → bytes¶

Returns the bytes received.

net_udp_packet->fromName() → string¶

Returns the server name that the data was sent from.

net_udp_packet->fromPort() → integer¶

Returns the port that the data was sent from.

Writing UDP Data¶

With a net_udp object, data is sent one packet at a time to a particular address and port combination. The receivers must be waiting to accept packets from other hosts.

net_udp->writeBytes(b::bytes, toAddress::string, toPort::integer) → integer¶

Sends the specified bytes to the indicated host. It returns the number of bytes that were sent.

Closing net_udp Objects¶

net_udp->close()¶

Although net_udp objects do not maintain a connection, they must still be closed when they are no longer needed to free up resources.

Creating net_named_pipe Objects¶

type net_named_pipe¶

net_named_pipe()

net_named_pipe(fd::filedesc)

The first method accepts no parameters and returns a new net_named_pipe object. Alternatively, a filedesc object that will be used to read and write data can be passed as a parameter.

Opening Named Pipe Connections¶

net_named_pipe->connect(to::string, timeoutSeconds::integer=4)¶

Attempts to connect to the indicated named pipe. This method returns “true” if the connection was made, and “false” otherwise.

Accepting Named Pipe Connections¶

net_named_pipe->bind(to::string)¶

net_named_pipe->listen(backlog::integer=128)¶

net_named_pipe->accept(timeoutSeconds::integer=-1)¶

The bind method attempts to create a pipe with the given name. It accepts one parameter which is the name of the pipe to create. There can be only one listener on any given pipe name. The method will fail if there is a problem creating the pipe.

The listen and accept methods operate as described for their net_tcp counterparts, except that accept will return new net_named_pipe objects for each new connection.