TcpClient

TcpClient objects in C++ are referenced by the following shared pointer typedef:

typedef std::shared_ptr<rogue::interfaces::memory::TcpClient> rogue::interfaces::memory::TcpClientPtr

Alias for using shared pointer as TcpClientPtr.

The class description is shown below:

class TcpClient : public rogue::interfaces::memory::Slave

Memory TCP Bridge Client.

This class implements a TCP bridge between a memory Master and a memory Slave. The client side of the TCP bridge accepts a memory Transaction from an attached master and forwards that Transaction to a remote TcpServer. The server side of the TCP bridge implements a memory Master device which executes the memory Transaction to an attached Slave.

The TcpClient memory interface will drop transactions when the remote server is not present or when the pipeline backs up.

Public Static Functions

static std::shared_ptr<rogue::interfaces::memory::TcpClient> create(std::string addr, uint16_t port)

Create a TcpClient object and return as a TcpServerPtr.

The creator takes an address and port. The passed address is the address of the remote TcpServer to connect to, and can either be an IP address or hostname. The memory bridge requires two TCP ports. The passed port is the base number of these two ports. A passed value of 8000 will result in both 8000 and 8001 being used by this bridge.

Exposed as rogue.interfaces.memory.TcpClient() to Python

Parameters:
  • addr – Interface address

  • port – Base port number to use for connection.

Returns:

TcpServer object as a TcpServerPtr