TCP Manual

Table of Contents

• About
• NetworkTcpInterface
• NetworkTcpServerInterface
• NetworkTcpConnectionInterface
• Further Reading

About

The Transmission Control Protocol allows to create network connections to remote machines in order to send data. The maxon::NetworkTcpInterface is used to create either an outgoing connection to send TCP/IP data or to create an server to receive such data.

Note

The TCP interface uses an AioService. See maxon::AioServiceInterface.

NetworkTcpInterface

The maxon::NetworkTcpInterface provides these functions:

• maxon::NetworkTcpInterface::OpenOutgoingConnection(): Creates a connection to a remote machine.
• maxon::NetworkTcpInterface::CreateServer(): Creates a server to receive messages from remote machines.

NetworkTcpServerInterface

The maxon::NetworkTcpServerInterface defines a TCP server that reacts to incoming TCP connections:

• maxon::NetworkTcpServerInterface::Start(): Starts the server.
• maxon::NetworkTcpServerInterface::Stop(): Stops the server.
• maxon::NetworkTcpServerInterface::IsStopped(): Returns true if the sever is stopped.
• maxon::NetworkTcpServerInterface::GetLocalAddress(): Returns the actual address of the local endpoint this server is bound to.
• maxon::NetworkTcpServerInterface::GetIoService(): Returns the assigned AioServiceRef.
• maxon::NetworkTcpServerInterface::GetJobQueue(): Returns the used job queue.

  // This example starts a TCP server. The behaviour on an incoming
  // connection is defined with the given callback function.
 
  // create AioService
  g_tcpIoService = maxon::AioServiceRef::Create() iferr_return;
  g_tcpIoService.Start() iferr_return;
 
  // create and start server
  auto localAddr = maxon::NetworkIpAddrPort(maxon::WILDCARD_IPV4_ADDRESS, 2000);
  g_tcpServer = maxon::NetworkTcpInterface::CreateServer(localAddr, TCPServerCallback, g_tcpIoService, maxon::JOBQUEUE_CURRENT) iferr_return;
  g_tcpServer.Start() iferr_return;

For an example on the callback function see below.

NetworkTcpConnectionInterface

The maxon::NetworkTcpConnectionInterface represents an established TCP connection. This connection can receive data from the remote machine or send data to that machine.

• maxon::NetworkTcpConnectionInterface::Receive(): Used to define a callback that receives incoming data.
• maxon::NetworkTcpConnectionInterface::Send(): Used to send data.
• maxon::NetworkTcpConnectionInterface::GetLocalAddress(): Returns the address of the local endpoint of this connection.
• maxon::NetworkTcpConnectionInterface::GetRemoteAddress(): Returns the address of the remote endpoint of this connection.
• maxon::NetworkTcpConnectionInterface::GetIoService(): Returns the assigned AioServiceRef.
• maxon::NetworkTcpConnectionInterface::GetJobQueue(): Returns the used job queue.

// This example shows a callback function that defines the behaviour of a TCP server for an incoming TCP connection.
 
static maxon::Result<void> TCPServerCallback(maxon::Result<void> res, maxon::NetworkTcpConnectionRef connection)
{
  iferr_scope;
 
  // print remote address
  const maxon::NetworkIpAddrPort remote = connection.GetRemoteAddress();
  DiagnosticOutput("Connected with @", remote);
 
  // define receive callback
  connection.Receive(
    [](maxon::Result<void> res, maxon::AioBuffer buffer) -> maxon::Result<void>
    {
      iferr_scope;
// print received message
      const maxon::String message { buffer };
      DiagnosticOutput("Message: @", message);
 
      return maxon::OK;
    }) iferr_return;
 
  return maxon::OK;
}

  // This example opens a TCP connection to a remote host and sends some data.
 
  // prepare AioServiceRef
  const maxon::AioServiceRef service = maxon::AioServiceRef::Create() iferr_return;
  service.Start() iferr_return;
 
  // open TCP connection
  maxon::NetworkTcpInterface::OpenOutgoingConnection(remoteAddr,
    [](maxon::Result<void>, maxon::NetworkTcpConnectionRef connection) -> maxon::Result<void>
    {
      iferr_scope;
 
// prepare message
      maxon::CString messageCStr("Test Message");
      maxon::AioBuffer buffer;
      for (const maxon::Char c: messageCStr)
      {
        iferr (buffer.Append(c))
          err.DbgStop();
      }
 
// send message
      return connection.Send(std::move(buffer));
 
    }, service, maxon::JOBQUEUE_CURRENT) iferr_return;

Further Reading

• Network
• Delegates