Remote Call Framework 3.1
RCF::ClientTransport Class Referenceabstract

Base class for all client transports. More...

#include <ClientTransport.hpp>

Inherited by RCF::ConnectedClientTransport, RCF::MulticastClientTransport, and RCF::UdpClientTransport.

Public Member Functions

virtual TransportType getTransportType ()=0
 Returns the transport type of this client transport. More...
 
void setMaxIncomingMessageLength (std::size_t maxMessageLength)
 
std::size_t getMaxIncomingMessageLength () const
 Returns maximum incoming message length. More...
 
void setMaxOutgoingMessageLength (std::size_t maxMessageLength)
 
std::size_t getMaxOutgoingMessageLength () const
 Returns maximum outgoing message length. More...
 
std::size_t getLastRequestSize ()
 Returns the byte size of the last request sent on the client transport. More...
 
std::size_t getLastResponseSize ()
 Returns the byte size of the last response received on the client transport. More...
 
std::uint64_t getRunningTotalBytesSent ()
 Returns the running total of bytes sent on the client transport. More...
 
std::uint64_t getRunningTotalBytesReceived ()
 Returns the running total of bytes received on the client transport. More...
 
void resetRunningTotals ()
 Resets the bytes-sent and bytes-received running totals to zero. More...
 

Detailed Description

Base class for all client transports.

Member Function Documentation

◆ getTransportType()

virtual TransportType RCF::ClientTransport::getTransportType ( )
pure virtual

Returns the transport type of this client transport.

◆ setMaxIncomingMessageLength()

void RCF::ClientTransport::setMaxIncomingMessageLength ( std::size_t  maxMessageLength)

Sets maximum incoming message length. Incoming messages that are larger than this size will be dropped.

◆ getMaxIncomingMessageLength()

std::size_t RCF::ClientTransport::getMaxIncomingMessageLength ( ) const

Returns maximum incoming message length.

◆ setMaxOutgoingMessageLength()

void RCF::ClientTransport::setMaxOutgoingMessageLength ( std::size_t  maxMessageLength)

Sets maximum outgoing message length. Outgoing messages that are larger than this size will trigger a client side exception.

◆ getMaxOutgoingMessageLength()

std::size_t RCF::ClientTransport::getMaxOutgoingMessageLength ( ) const

Returns maximum outgoing message length.

◆ getLastRequestSize()

std::size_t RCF::ClientTransport::getLastRequestSize ( )

Returns the byte size of the last request sent on the client transport.

◆ getLastResponseSize()

std::size_t RCF::ClientTransport::getLastResponseSize ( )

Returns the byte size of the last response received on the client transport.

◆ getRunningTotalBytesSent()

std::uint64_t RCF::ClientTransport::getRunningTotalBytesSent ( )

Returns the running total of bytes sent on the client transport.

◆ getRunningTotalBytesReceived()

std::uint64_t RCF::ClientTransport::getRunningTotalBytesReceived ( )

Returns the running total of bytes received on the client transport.

◆ resetRunningTotals()

void RCF::ClientTransport::resetRunningTotals ( )

Resets the bytes-sent and bytes-received running totals to zero.


The documentation for this class was generated from the following file: