User Manual, Developers Guide and API Documentation

wns::ldk Namespace Reference
[Layer Development Kit]

Layer Development Kit. More...


Classes

class  Command
 Base class for the PCI of a CommandTypeSpecifier.

Several Commands are grouped together using a CommandPool to form the PCI of a Layer. More...

class  CommandPool
 Build a PCI from a set of Commands.

A Layer may consist of serveral functional units. Each of these functional units may need some additional elements within the PCI. Since the composition of functional units into a Layer is done at runtime, there is no easy way to build a PCI in advance. More...

class  CommandProxy
 Manage Commands within a CommandPool and make them accessible. More...
class  CommandReaderInterface
class  CommandTypeSpecifier
 Equip a FunctionalUnit with functionality that depends on the type of Command.

Implements CommandTypeSpecifierInterface. More...

class  CommandTypeSpecifierInterface
 Abstract interface to be implemented by a CommandTypeSpecifier.

Strictly spoken, this is not an Interface, since it decorates the FunctionalUnit with the PCI-id tagging methods. More...

class  Compound
 Basic transmission unit within a fun::FUN. More...
struct  CompoundHandlerInterface
 Interface for the aspect of dealing with compounds. More...
class  Connector
 Connector scheduling strategy interface.

Connector is one of the 5 aspects of a FU (see The 5 aspects of a FunctionalUnit.)
. More...

class  ConnectorReceptacleRegistry
class  ConnectorRegistry
class  ControlService
 Common base class for Control Services. More...
class  ControlServiceInterface
 Interface definition for Control Services. More...
class  ControlServiceRegistry
 The ControlServiceRegistry keeps all instances of ControlServices. More...
class  CopyCommandInterface
struct  CSRConfigCreator
 Creator implementation to be used with StaticFactory. More...
struct  wns::ldk::CSRConfigCreator< KIND, KIND >
class  Delayed
 Adapter implementing the CompoundHandlerInterface for functional units that have memory.

For documentation see DelayedInterface. More...

class  DelayedDeliveryInterface
struct  DelayedInterface
 Interface to be implemented by users of the Delayed adapter.

When implementing functional units, you frequently have to implement functional units with some internal memory for compounds. To ease implementation of intra-layer flow control, Delayed implements the CompoundHandlerInterface, and offers a different interface:. More...

class  Deliverer
 Deliverer scheduling strategy interface.

Deliverer is one of the 5 aspects of a FU (see The 5 aspects of a FunctionalUnit.)
. More...

class  DelivererReceptacleRegistry
class  DelivererRegistry
class  Dropper
 Adapter implementing the CompoundHandlerInterface for processing-only functional units.

For documentation see DropperInterface. More...

struct  DropperInterface
 Interface to be implemented by users of the Dropper adapter.

To implement functional units that have no internal memory and do PDU mutation and dropping only, you may use the Dropper adapter to get a more suitable interface.
. More...

class  EmptyCommand
class  ErrorRateProviderInterface
 Derive from this class if the Command of your FU needs to carry error rate (BER or PER) information to another FU, e.g. the CRC unit. More...
class  FirstServeConnector
class  FlowGate
class  FlowGateInterface
class  FlowSeparator
 Manage FU instances for different flows. More...
class  Forwarding
 Implement the Processor interface, forwarding packets without mutation. More...
struct  FUNConfigCreator
 Creator implementation to be used with StaticFactory. More...
struct  wns::ldk::FUNConfigCreator< KIND, KIND >
class  FunctionalUnit
 Abstract base class for functional units. More...
class  FunctionalUnitRC
class  GetHasConnector
class  GetHasDeliverer
class  GetHasReceptor
class  Group
 Functional Unit holding a Sub FUN.

ldk::fun::Sub is a FUN that can be placed within another FUN. Group is a FU wrapping such a Sub FUN. More...

class  HasConnector
 Implements the HasConnector Interface for a given scheduling strategy. More...
class  HasConnectorInterface
 Interface for the aspect of handling lower functional units. More...
class  HasConnectorReceptacle
class  wns::ldk::HasConnectorReceptacle< CLASS, SinglePort >
class  HasDeliverer
 Implement the HasDeliverer Interface for a given scheduling strategy. More...
struct  HasDelivererInterface
 Interface for the aspect of handling delivery of incomping compounds. More...
class  HasDelivererReceptacle
class  wns::ldk::HasDelivererReceptacle< CLASS, SinglePort >
class  HasDownPort
class  wns::ldk::HasDownPort< CLASS, Port< SinglePort >, CONNECTORTYPE >
class  HasReceptor
 Implement the HasReceptor Interface for a given scheduling strategy. More...
struct  HasReceptorInterface
 Interface for the aspect of handling upper functional units. More...
class  HasReceptorReceptacle
class  wns::ldk::HasReceptorReceptacle< CLASS, SinglePort >
class  HasUpPort
class  wns::ldk::HasUpPort< CLASS, Port< SinglePort >, DELIVERERTYPE, RECEPTORTYPE >
class  IConnectorReceptacle
class  IDelivererReceptacle
class  ILayer
class  IPortID
class  IReceptorReceptacle
class  Key
class  KeyBuilder
class  Layer
 The Layer is the base class of all Layers implemented into the wns. More...
struct  LayerConfigCreator
 Creator implementation to be used with StaticFactory. More...
struct  wns::ldk::LayerConfigCreator< KIND, KIND >
class  Link
 Link between FUs. More...
class  LinkHandlerInterface
class  ManagementService
class  ManagementServiceInterface
 Interface definition for Management Services. More...
class  ManagementServiceRegistry
 The ManagementServiceRegistry keeps all instances of ManagementServices. More...
struct  MSRConfigCreator
 Creator implementation to be used with StaticFactory. More...
struct  wns::ldk::MSRConfigCreator< KIND, KIND >
class  MultiLink
class  Port
class  Processor
 Adapter implementing the CompoundHandlerInterface for processing-only functional units.

For documentation see ProcessorInterface. More...

struct  ProcessorInterface
 Interface to be implemented by users of the Processor adapter.

To implement functional units that have no internal memory and do PDU mutation only, you may use the Processor adapter to get a more suitable interface.
. More...

struct  PyConfigCreator
 Creator implementation to be used with StaticFactory. More...
struct  wns::ldk::PyConfigCreator< KIND, KIND >
class  RandomAccessLink
class  Receptor
 Receptor scheduling strategy implementation.

Receptor is one of the 5 aspects of a FU (see The 5 aspects of a FunctionalUnit.)
. More...

class  ReceptorReceptacleRegistry
class  ReceptorRegistry
class  RoundRobinConnector
 Round robin scheduling strategy, picking only accepting functional units

This class. More...

class  RoundRobinDeliverer
 Round robin scheduling strategy

This class. More...

class  RoundRobinLink
class  RoundRobinReceptor
 Receptor scheduling strategy implementation.

Receptor is one of the 5 aspects of a FU (see The 5 aspects of a FunctionalUnit.)
. More...

class  SequentlyCallingLinkHandler
class  ShortcutFU
 The ShortcutFU provides straight connection of corresponding ShortcutFUs in peer entities. The instances register themselves with their unique addresses available in the module the FU is being placed. More...
class  SimpleLinkHandler
class  SingleConnection
class  SingleConnector
 Provides and restricts the connecting aspect of the FU to exactly one link. More...
class  SingleDeliverer
 Single link to antother FU. More...
class  SingleLink
class  SinglePort
class  SingleReceptor
 Receptor scheduling strategy implementation.

Receptor is one of the 5 aspects of a FU (see The 5 aspects of a FunctionalUnit.)
. More...

class  SuspendableInterface
class  SuspendedInterface
class  SuspendSupport
struct  Visit

Namespaces

namespace  arq
 ARQ - Automatic Repeat reQuest implementations for ldk.
namespace  buffer
 Buffer - Various implementations of buffering functional units.
namespace  command
 Command - Commond control plane functional units (FlowControl,...).
namespace  concatenation
 Concatenation - Concat several compounds.
namespace  crc
 CRC - Cyclic Redundancy Check implementation for ldk.
namespace  fcf
 FCF - Frame Configuration Framework.
namespace  flowseparator
namespace  fsm
namespace  fun
 FUN - FUN implementations (Main and Sub FUNs).
namespace  harq
namespace  hasconnector
 HasConnector specific type declarations.
namespace  hasdeliverer
 HasDeliverer specific type declarations.
namespace  hasreceptor
namespace  hasupper
 HasReceptor specific type declarations.
namespace  helper
 Classes used by ldk internally.
namespace  multiplexer
 Multiplexer - FUs supporting the configuration of branching FUNs.
namespace  probe
 Probes - Probing FUs. Add those to your FUN for measurements.
namespace  sar
 SAR - Segmentation And Reassembly implementations for ldk.
namespace  tools
 Swiss army knife set of ready to use functional units.

Typedefs

typedef SmartPtr< CompoundCompoundPtr
typedef SmartPtr< const KeyConstKeyPtr
typedef CSRConfigCreator
< ControlServiceInterface
ControlServiceCreator
typedef StaticFactory
< ControlServiceCreator
ControlServiceFactory
typedef FUNConfigCreator
< FunctionalUnit
FunctionalUnitCreator
typedef wns::StaticFactory
< FunctionalUnitCreator
FunctionalUnitFactory
typedef FUNConfigCreator
< KeyBuilder
KeyBuilderCreator
typedef wns::StaticFactory
< KeyBuilderCreator
KeyBuilderFactory
typedef SmartPtr< KeyKeyPtr
typedef MSRConfigCreator
< ManagementServiceInterface
ManagementServiceCreator
typedef StaticFactory
< ManagementServiceCreator
ManagementServiceFactory

Functions

FunctionalUnitconfiguredFunctionalUnit (fun::FUN *fuNet, const pyconfig::View &config)
void configureFUN (fun::FUN *fuNet, const pyconfig::View &config)
 ENUM (OUTGOING, 1)
 ENUM (INCOMING, 0)
 ENUM_BEGIN (Direction)
 ENUM_END ()


Typedef Documentation

Definition at line 188 of file Compound.hpp.

Definition at line 58 of file Key.hpp.

Definition at line 144 of file ControlServiceInterface.hpp.

Definition at line 145 of file ControlServiceInterface.hpp.

Definition at line 341 of file FunctionalUnit.hpp.

Definition at line 342 of file FunctionalUnit.hpp.

Definition at line 74 of file Key.hpp.

Definition at line 75 of file Key.hpp.

Definition at line 57 of file Key.hpp.

Definition at line 143 of file ManagementServiceInterface.hpp.

Definition at line 144 of file ManagementServiceInterface.hpp.


Function Documentation

FunctionalUnit * wns::ldk::configuredFunctionalUnit ( fun::FUN fuNet,
const pyconfig::View config 
)

Definition at line 35 of file utils.cpp.

void wns::ldk::configureFUN ( fun::FUN fuNet,
const pyconfig::View config 
)

Definition at line 49 of file utils.cpp.

wns::ldk::ENUM ( OUTGOING  ,
 
)

wns::ldk::ENUM ( INCOMING  ,
 
)

wns::ldk::ENUM_BEGIN ( Direction   ) 

wns::ldk::ENUM_END (  ) 


Generated on Wed Feb 8 03:32:57 2012 for openWNS by  doxygen 1.5.5