network_link_registry Class

The network_link_registry abstract base class manages the links between source and target blocks.

Syntax

template<class _Block>
class network_link_registry;

Parameters

_Block
The block data type being stored in the network_link_registry.

Members

Public Typedefs

Name Description
const_pointer A type that provides a pointer to a const element in a network_link_registry object.
const_reference A type that provides a reference to a const element stored in a network_link_registry object for reading and performing const operations.
iterator A type that provides an iterator that can read or modify any element in a network_link_registry object.
type A type that represents the block type stored in the network_link_registry object.

Public Methods

Name Description
add When overridden in a derived class, adds a link to the network_link_registry object.
begin When overridden in a derived class, returns an iterator to the first element in the network_link_registry object.
contains When overridden in a derived class, searches the network_link_registry object for a specified block.
count When overridden in a derived class, returns the number of items in the network_link_registry object.
remove When overridden in a derived class, removes a specified block from the network_link_registry object.

Remarks

The network link registry is not safe for concurrent access.

Inheritance Hierarchy

network_link_registry

Requirements

Header: agents.h

Namespace: concurrency

add

When overridden in a derived class, adds a link to the network_link_registry object.

virtual void add(_EType _Link) = 0;

Parameters

_Link
A pointer to a block to be added.

begin

When overridden in a derived class, returns an iterator to the first element in the network_link_registry object.

virtual iterator begin() = 0;

Return Value

An iterator addressing the first element in the network_link_registry object.

Remarks

The end state of the iterator is indicated by a NULL link.

contains

When overridden in a derived class, searches the network_link_registry object for a specified block.

virtual bool contains(_EType _Link) = 0;

Parameters

_Link
A pointer to a block that is being searched for in the network_link_registry object.

Return Value

true if the block was found, false otherwise.

count

When overridden in a derived class, returns the number of items in the network_link_registry object.

virtual size_t count() = 0;

Return Value

The number of items in the network_link_registry object.

remove

When overridden in a derived class, removes a specified block from the network_link_registry object.

virtual bool remove(_EType _Link) = 0;

Parameters

_Link
A pointer to a block to be removed, if found.

Return Value

true if the link was found and removed, false otherwise.

See also

concurrency Namespace
single_link_registry Class
multi_link_registry Class