Net module

PacketSocketEmitter

Socket adapter that emits received data as packets.

PacketSocketEmitter

#include <icy/net/packetsocket.h>

class PacketSocketEmitter

Defined in src/net/include/icy/net/packetsocket.h:32

Inherits: SocketEmitter, Signal< void(IPacket &)> Subclassed by: Transaction< Message >, Transaction< PacketT >

Socket adapter that emits received data as packets.

List of all members

Name	Kind	Owner
`factory`	`variable`	Declared here
`PacketSocketEmitter`	`function`	Declared here
`~PacketSocketEmitter`	`function`	Declared here
`onSocketRecv`	`function`	Declared here
`onPacket`	`function`	Declared here
`Connect`	`variable`	Inherited from `SocketEmitter`
`Recv`	`variable`	Inherited from `SocketEmitter`
`Error`	`variable`	Inherited from `SocketEmitter`
`Close`	`variable`	Inherited from `SocketEmitter`
`impl`	`variable`	Inherited from `SocketEmitter`
`SocketEmitter`	`function`	Inherited from `SocketEmitter`
`SocketEmitter`	`function`	Inherited from `SocketEmitter`
`~SocketEmitter`	`function`	Inherited from `SocketEmitter`
`addReceiver`	`function`	Inherited from `SocketEmitter`
`removeReceiver`	`function`	Inherited from `SocketEmitter`
`swap`	`function`	Inherited from `SocketEmitter`
`as`	`function`	Inherited from `SocketEmitter`
`operator->`	`function`	Inherited from `SocketEmitter`
`onSocketConnect`	`function`	Inherited from `SocketEmitter`
`onSocketRecv`	`function`	Inherited from `SocketEmitter`
`onSocketError`	`function`	Inherited from `SocketEmitter`
`onSocketClose`	`function`	Inherited from `SocketEmitter`
`priority`	`variable`	Inherited from `SocketAdapter`
`SocketAdapter`	`function`	Inherited from `SocketAdapter`
`~SocketAdapter`	`function`	Inherited from `SocketAdapter`
`send`	`function`	Inherited from `SocketAdapter`
`send`	`function`	Inherited from `SocketAdapter`
`sendOwned`	`function`	Inherited from `SocketAdapter`
`sendOwned`	`function`	Inherited from `SocketAdapter`
`sendPacket`	`function`	Inherited from `SocketAdapter`
`sendPacket`	`function`	Inherited from `SocketAdapter`
`sendPacket`	`function`	Inherited from `SocketAdapter`
`setSender`	`function`	Inherited from `SocketAdapter`
`sender`	`function`	Inherited from `SocketAdapter`
`addReceiver`	`function`	Inherited from `SocketAdapter`
`removeReceiver`	`function`	Inherited from `SocketAdapter`
`hasReceiver`	`function`	Inherited from `SocketAdapter`
`receivers`	`function`	Inherited from `SocketAdapter`
`onSocketConnect`	`function`	Inherited from `SocketAdapter`
`onSocketRecv`	`function`	Inherited from `SocketAdapter`
`onSocketError`	`function`	Inherited from `SocketAdapter`
`onSocketClose`	`function`	Inherited from `SocketAdapter`
`_sender`	`variable`	Inherited from `SocketAdapter`
`_receivers`	`variable`	Inherited from `SocketAdapter`
`_dirty`	`variable`	Inherited from `SocketAdapter`
`cleanupReceivers`	`function`	Inherited from `SocketAdapter`

Inherited from `SocketEmitter`

Kind	Name	Description
`variable`	`Connect`	Signals that the socket is connected.
`variable`	`Recv`	Signals when data is received by the socket.
`variable`	`Error`	Signals that the socket is closed in error. This signal will be sent just before the Closed signal.
`variable`	`Close`	Signals that the underlying socket is closed.
`variable`	`impl`	Pointer to the underlying socket. Sent data will be proxied to this socket.
`function`	`SocketEmitter`	Creates the SocketEmitter and optionally attaches it to a socket. If `socket` is provided, this emitter registers itself as a receiver.
`function`	`SocketEmitter`	Copy constructor; copies all signal connections and attaches to the same socket.
`function`	`~SocketEmitter` `virtual` `noexcept`	Destroys the SocketAdapter.
`function`	`addReceiver` `virtual` `override`	Attaches a SocketAdapter as a receiver; wires it to all four socket signals.
`function`	`removeReceiver` `virtual` `override`	Detaches a SocketAdapter from all four socket signals.
`function`	`swap` `virtual`	Replaces the underlying socket with `socket`.
`function`	`as` `inline`	Returns the underlying socket cast to type T, or nullptr if the cast fails.
`function`	`operator->` `const` `inline`	Returns a raw pointer to the underlying socket for direct method access. Follows shared_ptr semantics; the caller must not delete the returned pointer.
`function`	`onSocketConnect` `virtual` `override`	Forwards the connect event to chained adapters, then fires the Connect signal.
`function`	`onSocketRecv` `virtual` `override`	Forwards the recv event to chained adapters, then fires the Recv signal.
`function`	`onSocketError` `virtual` `override`	Forwards the error event to chained adapters, then fires the Error signal.
`function`	`onSocketClose` `virtual` `override`	Forwards the close event to chained adapters, then fires the Close signal.

Inherited from `SocketAdapter`

Kind	Name	Description
`variable`	`priority`	The priority of this adapter for STL sort operations.
`function`	`SocketAdapter`	Creates the SocketAdapter.
`function`	`~SocketAdapter` `virtual` `noexcept`	Destroys the SocketAdapter.
`function`	`send` `virtual`	Sends the given data buffer to the connected peer. Returns the number of bytes sent or -1 on error. No exception will be thrown. For TCP sockets the given peer address must match the connected peer address.
`function`	`send` `virtual`
`function`	`sendOwned` `virtual`	Sends an owned payload buffer to the connected peer.
`function`	`sendOwned` `virtual`
`function`	`sendPacket` `virtual`	Sends the given packet to the connected peer. Returns the number of bytes sent or -1 on error. No exception will be thrown. For TCP sockets the given peer address must match the connected peer address.
`function`	`sendPacket` `virtual`
`function`	`sendPacket` `virtual`	Sends the given packet to the connected peer. This method provides delegate compatibility, and unlike other send methods throws an exception if the underlying socket is closed.
`function`	`setSender` `virtual`	Sets the pointer to the outgoing data adapter. Send methods proxy data to this adapter by default.
`function`	`sender`	Returns the output SocketAdapter pointer.
`function`	`addReceiver` `virtual`	Sets the pointer to the incoming data adapter. Events proxy data to this adapter by default.
`function`	`removeReceiver` `virtual`	Remove the given receiver.
`function`	`hasReceiver` `virtual`	Returns true if the given receiver is connected.
`function`	`receivers`	Returns all currently registered input SocketAdapter pointers. Dead (removed) entries are excluded from the returned list.
`function`	`onSocketConnect` `virtual`	Called when the socket establishes a connection. Forwards the event to all registered receivers in priority order. Override to intercept before the application sees the event.
`function`	`onSocketRecv` `virtual`	Called when data is received from the socket. Forwards the event to all registered receivers in priority order.
`function`	`onSocketError` `virtual`	Called when the socket encounters an error. Forwards the event to all registered receivers in priority order.
`function`	`onSocketClose` `virtual`	Called when the socket is closed. Forwards the event to all registered receivers in priority order.
`variable`	`_sender`
`variable`	`_receivers`
`variable`	`_dirty`
`function`	`cleanupReceivers` `virtual`

Public Attributes

Return	Name	Description
`PacketFactory`	`factory`	The packet factory.

factory

PacketFactory factory

Defined in src/net/include/icy/net/packetsocket.h:59

The packet factory.

Public Methods

Return	Name	Description
	`PacketSocketEmitter`	Creates the PacketSocketEmitter and attaches it to the given socket.
`bool`	`onSocketRecv` `virtual` `override`	Parses raw received data into packets via the factory and forwards each parsed packet to onPacket(). Returns true if propagation should stop.
`bool`	`onPacket` `virtual`	Process a parsed packet. Returns true to stop propagation.

PacketSocketEmitter

PacketSocketEmitter(const Socket::Ptr & socket = nullptr)

Defined in src/net/include/icy/net/packetsocket.h:43

Creates the PacketSocketEmitter and attaches it to the given socket.

The emitter should be assigned a higher priority than plain socket adapters so that packet parsing occurs before generic data callbacks. Packets are created and dispatched using the registered factory strategies; strategies with the highest priority are tried first.

Parameters

socket Optional socket to attach to immediately.

onSocketRecv

virtual override

virtual bool onSocketRecv(Socket & socket, const MutableBuffer & buffer, const Address & peerAddress) override

Defined in src/net/include/icy/net/packetsocket.h:53

Parses raw received data into packets via the factory and forwards each parsed packet to onPacket(). Returns true if propagation should stop.

Parameters

socket The socket that received the data.
buffer The raw received data buffer.
peerAddress The sender's address.

Returns

true if the event was consumed and should not propagate further.

Reimplements

onSocketRecv

onPacket

virtual

virtual bool onPacket(IPacket & pkt)

Defined in src/net/include/icy/net/packetsocket.h:56

Process a parsed packet. Returns true to stop propagation.

Reimplemented by

Built with