Murl::Net::ISocketPacket Interface Referenceabstract

The socket packet interface. More...

#include "murl_net_i_socket_packet.h"

Inherited by Murl::Net::SocketPacket.

Public Member Functions

virtual const StringGetSenderName () const =0
 Get the sender name. More...
 
virtual const StringGetUniqueIdentifier () const =0
 Get the sender unique identifier. More...
 
virtual ISocketAddressCPtr GetAddress () const =0
 Get the sender address object. More...
 
virtual const DataGetData () const =0
 Get the const sender data object. More...
 
virtual DataGetData ()=0
 Get the sender data object. More...
 
virtual void SetSenderName (const String &senderName)=0
 Set the sender name. More...
 
virtual void SetUniqueIdentifier (const String &uniqueId)=0
 Set the sender unique identifier. More...
 
virtual void SetAddress (ISocketAddressCPtr address)=0
 Set the sender address. More...
 
virtual void SetData (const ConstData &data)=0
 Set the sender data object. More...
 
virtual void ObtainData (Data &data)=0
 Obtain the sender data object. More...
 
virtual UInt64 GetBytesToSend () const =0
 Get the number of bytes to send. More...
 
virtual UInt64 GetBytesSent () const =0
 Get the number of sent bytes. More...
 
virtual UInt64 GetBytesToReceive () const =0
 Get the number of bytes to receive. More...
 
virtual UInt64 GetBytesReceived () const =0
 Get the number of received bytes. More...
 
virtual void SetBytesToSend (UInt64 numberOfBytes)=0
 Set the number of bytes to send. More...
 
virtual void SetBytesSent (UInt64 numberOfBytes)=0
 Set the number of sent bytes. More...
 
virtual void SetBytesToReceive (UInt64 numberOfBytes)=0
 Set the number of bytes to receive. More...
 
virtual void SetBytesReceived (UInt64 numberOfBytes)=0
 Set the number of received bytes. More...
 

Detailed Description

The socket packet interface.

Packets are used to transfer network data from and to the Net::SocketClient and Net::SocketServer interfaces.

Member Function Documentation

◆ GetSenderName()

virtual const String& Murl::Net::ISocketPacket::GetSenderName ( ) const
pure virtual

Get the sender name.

Returns
The sender name.

◆ GetUniqueIdentifier()

virtual const String& Murl::Net::ISocketPacket::GetUniqueIdentifier ( ) const
pure virtual

Get the sender unique identifier.

Returns
The sender unique identifier.

◆ GetAddress()

virtual ISocketAddressCPtr Murl::Net::ISocketPacket::GetAddress ( ) const
pure virtual

Get the sender address object.

Returns
The sender address object.

◆ GetData() [1/2]

virtual const Data& Murl::Net::ISocketPacket::GetData ( ) const
pure virtual

Get the const sender data object.

Returns
The const sender data object.

◆ GetData() [2/2]

virtual Data& Murl::Net::ISocketPacket::GetData ( )
pure virtual

Get the sender data object.

Returns
The sender data object.

◆ SetSenderName()

virtual void Murl::Net::ISocketPacket::SetSenderName ( const String senderName)
pure virtual

Set the sender name.

Parameters
senderNameThe sender name.

◆ SetUniqueIdentifier()

virtual void Murl::Net::ISocketPacket::SetUniqueIdentifier ( const String uniqueId)
pure virtual

Set the sender unique identifier.

Parameters
uniqueIdThe sender unique identifier.

◆ SetAddress()

virtual void Murl::Net::ISocketPacket::SetAddress ( ISocketAddressCPtr  address)
pure virtual

Set the sender address.

Parameters
addressThe sender address.

◆ SetData()

virtual void Murl::Net::ISocketPacket::SetData ( const ConstData data)
pure virtual

Set the sender data object.

Parameters
dataThe sender data to copy.

◆ ObtainData()

virtual void Murl::Net::ISocketPacket::ObtainData ( Data data)
pure virtual

Obtain the sender data object.

Parameters
dataThe sender data object to obtain.

◆ GetBytesToSend()

virtual UInt64 Murl::Net::ISocketPacket::GetBytesToSend ( ) const
pure virtual

Get the number of bytes to send.

Returns
The number of bytes to send.

◆ GetBytesSent()

virtual UInt64 Murl::Net::ISocketPacket::GetBytesSent ( ) const
pure virtual

Get the number of sent bytes.

Returns
The number of bytes to send.

◆ GetBytesToReceive()

virtual UInt64 Murl::Net::ISocketPacket::GetBytesToReceive ( ) const
pure virtual

Get the number of bytes to receive.

Returns
The number of bytes to receive.

◆ GetBytesReceived()

virtual UInt64 Murl::Net::ISocketPacket::GetBytesReceived ( ) const
pure virtual

Get the number of received bytes.

Returns
The number of received bytes.

◆ SetBytesToSend()

virtual void Murl::Net::ISocketPacket::SetBytesToSend ( UInt64  numberOfBytes)
pure virtual

Set the number of bytes to send.

Parameters
numberOfBytesThe number of bytes to send.

◆ SetBytesSent()

virtual void Murl::Net::ISocketPacket::SetBytesSent ( UInt64  numberOfBytes)
pure virtual

Set the number of sent bytes.

Parameters
numberOfBytesThe number of bytes to send.

◆ SetBytesToReceive()

virtual void Murl::Net::ISocketPacket::SetBytesToReceive ( UInt64  numberOfBytes)
pure virtual

Set the number of bytes to receive.

Parameters
numberOfBytesThe number of bytes to receive.

◆ SetBytesReceived()

virtual void Murl::Net::ISocketPacket::SetBytesReceived ( UInt64  numberOfBytes)
pure virtual

Set the number of received bytes.

Parameters
numberOfBytesThe number of received bytes.

The documentation for this interface was generated from the following file:
  • murl_net_i_socket_packet.h


Copyright © 2011-2018 Spraylight GmbH.