PacketFactory

#include <icy/packetfactory.h>

class PacketFactory

Defined in src/base/include/icy/packetfactory.h:95

Priority-ordered factory that creates typed packets from raw buffers using registered strategies.

List of all members

Name	Kind	Owner
`PacketFactory`	`function`	Declared here
`PacketFactory`	`function`	Declared here
`operator=`	`function`	Declared here
`PacketFactory`	`function`	Declared here
`operator=`	`function`	Declared here
`~PacketFactory`	`function`	Declared here
`registerPacketType`	`function`	Declared here
`unregisterPacketType`	`function`	Declared here
`registerStrategy`	`function`	Declared here
`unregisterStrategy`	`function`	Declared here
`types`	`function`	Declared here
`types`	`function`	Declared here
`onPacketCreated`	`function`	Declared here
`createPacket`	`function`	Declared here
`_types`	`variable`	Declared here
`sortTypes`	`function`	Declared here

Public Methods

Return	Name	Description
	`PacketFactory`	Defaulted constructor.
	`PacketFactory`	Deleted constructor.
	`PacketFactory`	Defaulted constructor.
`void`	`registerPacketType` `inline`	Registers a `[PacketCreationStrategy](icy-PacketCreationStrategy.html#packetcreationstrategy)<PacketT>` at the given priority. Any previously registered strategy for `PacketT` is replaced.
`void`	`unregisterPacketType` `inline`	Removes the `[PacketCreationStrategy](icy-PacketCreationStrategy.html#packetcreationstrategy)<PacketT>` from the factory, if present.
`void`	`registerStrategy` `inline`	Registers an arbitrary `[IPacketCreationStrategy](icy-IPacketCreationStrategy.html#ipacketcreationstrategy)` subclass at the given priority. Any previously registered instance of the same type is replaced.
`void`	`unregisterStrategy` `inline`	Removes the `StrategyT` instance from the factory, if present.
`PacketCreationStrategyList &`	`types` `inline`
`const PacketCreationStrategyList &`	`types` `const` `inline`
`bool`	`onPacketCreated` `virtual` `inline`	Called after a packet is successfully created by a strategy. Override to apply filtering; return false to reject the packet (it will be deleted).
`IPacket *`	`createPacket` `virtual` `inline`	Iterates registered strategies in priority order and returns the first successfully created packet.

PacketFactory

PacketFactory() = default

Defined in src/base/include/icy/packetfactory.h:98

Defaulted constructor.

PacketFactory

PacketFactory(const PacketFactory &) = delete

Defined in src/base/include/icy/packetfactory.h:99

Deleted constructor.

PacketFactory

PacketFactory(PacketFactory &&) = default

Defined in src/base/include/icy/packetfactory.h:101

Defaulted constructor.

registerPacketType

inline

template<class PacketT> inline void registerPacketType(int priority)

Defined in src/base/include/icy/packetfactory.h:110

Registers a [PacketCreationStrategy](icy-PacketCreationStrategy.html#packetcreationstrategy)<PacketT> at the given priority. Any previously registered strategy for PacketT is replaced.

Parameters

PacketT Packet type to register; must default-constructible with a read() method.

Parameters

priority Dispatch priority (0–100; higher runs first).

unregisterPacketType

inline

template<class PacketT> inline void unregisterPacketType()

Defined in src/base/include/icy/packetfactory.h:120

Removes the [PacketCreationStrategy](icy-PacketCreationStrategy.html#packetcreationstrategy)<PacketT> from the factory, if present.

Parameters

PacketT Packet type whose strategy should be removed.

registerStrategy

inline

template<class StrategyT> inline void registerStrategy(int priority)

Defined in src/base/include/icy/packetfactory.h:134

Registers an arbitrary [IPacketCreationStrategy](icy-IPacketCreationStrategy.html#ipacketcreationstrategy) subclass at the given priority. Any previously registered instance of the same type is replaced.

Parameters

StrategyT Strategy type to instantiate; must accept a priority int in its constructor.

Parameters

priority Dispatch priority (0–100; higher runs first).

unregisterStrategy

inline

template<class StrategyT> inline void unregisterStrategy()

Defined in src/base/include/icy/packetfactory.h:144

Removes the StrategyT instance from the factory, if present.

Parameters

StrategyT Strategy type to remove.

types

inline

inline PacketCreationStrategyList & types()

Defined in src/base/include/icy/packetfactory.h:154

Returns

Mutable reference to the ordered list of registered strategies.

types

const inline

inline const PacketCreationStrategyList & types() const

Defined in src/base/include/icy/packetfactory.h:160

Returns

Const reference to the ordered list of registered strategies.

onPacketCreated

virtual inline

virtual inline bool onPacketCreated(IPacket * packet)

Defined in src/base/include/icy/packetfactory.h:169

Called after a packet is successfully created by a strategy. Override to apply filtering; return false to reject the packet (it will be deleted).

Parameters

packet Newly created packet.

Returns

True to accept the packet, false to discard it and try the next strategy.

createPacket

virtual inline

virtual inline IPacket * createPacket(const ConstBuffer & buffer, size_t & nread)

Defined in src/base/include/icy/packetfactory.h:181

Iterates registered strategies in priority order and returns the first successfully created packet.

Parameters

buffer Raw input data.
nread Set to the number of bytes consumed on success.

Returns

Newly allocated packet, or nullptr if no strategy matched.

Exceptions

std::logic_error if no packet types have been registered.

Protected Attributes

Return	Name	Description
`PacketCreationStrategyList`	`_types`

_types

PacketCreationStrategyList _types

Defined in src/base/include/icy/packetfactory.h:200

Private Methods

Return	Name	Description
`void`	`sortTypes` `inline`

sortTypes

inline

inline void sortTypes()

Defined in src/base/include/icy/packetfactory.h:203