Net module
PacketInfo
Provides information about packets emitted from a socket.
#include <icy/net/socket.h>
struct PacketInfoDefined in src/net/include/icy/net/socket.h:155
- Inherits
IPacketInfo
Provides information about packets emitted from a socket. See SocketPacket.
List of all members
| Name | Kind | Owner |
|---|---|---|
socket | variable | Declared here |
peerAddress | variable | Declared here |
PacketInfo | function | Declared here |
PacketInfo | function | Declared here |
clone | function | Declared here |
~PacketInfo | function | Declared here |
IPacketInfo | function | Inherited from IPacketInfo |
~IPacketInfo | function | Inherited from IPacketInfo |
clone | function | Inherited from IPacketInfo |
Inherited from IPacketInfo
| Kind | Name | Description |
|---|---|---|
function | IPacketInfo | Defaulted constructor. |
function | ~IPacketInfo virtual | Defaulted destructor. |
function | clone virtual const | Returns a heap-allocated deep copy of this info object. |
Public Attributes
| Return | Name | Description |
|---|---|---|
Socket::Ptr | socket | The source socket. |
Address | peerAddress | The originating peer address. For TCP this will always be connected address. |
socket
Socket::Ptr socketType: Socket::Ptr
Defined in src/net/include/icy/net/socket.h:158
The source socket.
peerAddress
Address peerAddressType: Address
Defined in src/net/include/icy/net/socket.h:162
The originating peer address. For TCP this will always be connected address.
Public Methods
| Return | Name | Description |
|---|---|---|
PacketInfo inline | Constructs PacketInfo with the originating socket and peer address. | |
PacketInfo inline | Copy constructor. | |
std::unique_ptr< IPacketInfo > | clone virtual const inline | Returns a heap-allocated copy of this PacketInfo. |
~PacketInfo virtual noexcept | Defaulted destructor. |
PacketInfo
inline
inline PacketInfo(const Socket::Ptr & socket, const Address & peerAddress)Defined in src/net/include/icy/net/socket.h:167
Constructs PacketInfo with the originating socket and peer address.
Parameters
| Parameter | Type | Description |
|---|---|---|
socket | const Socket::Ptr & | Shared pointer to the socket that received the packet. |
peerAddress | const Address & | Address of the remote peer that sent the packet. |
PacketInfo
inline
inline PacketInfo(const PacketInfo & r)Defined in src/net/include/icy/net/socket.h:175
Copy constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
r | const PacketInfo & | Source PacketInfo to copy from. |
clone
virtual const inline
virtual inline std::unique_ptr< IPacketInfo > clone() constDefined in src/net/include/icy/net/socket.h:182
Returns a heap-allocated copy of this PacketInfo.
Reimplements
~PacketInfo
virtual noexcept
virtual ~PacketInfo() noexcept = defaultDefined in src/net/include/icy/net/socket.h:184
Defaulted destructor.