AFI
Advanced Forwarding Interface
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups
Classes | Typedefs | Functions
Server

Classes used to define the underlying server classes and architecture. More...

Classes

class  AftServer
 Base virtual class used for all servers. More...
 

Typedefs

typedef std::shared_ptr
< AftServer
AftServerPtr
 Pointer type for all AftServer objects.
 

Functions

virtual bool AftServer::alloc (const std::string &engineName, const std::string &name, const uint16_t inputPorts, const uint16_t outputPorts)=0
 Allocate a new sandbox on the nominated engine. More...
 
virtual bool AftServer::open (const std::string &name, const AftTransportPtr &transport, AftSandboxPtr &sandbox)=0
 Open an existing sandbox on the server. More...
 
virtual bool AftServer::release (const std::string &name)=0
 Release an existing sandbox and all associated resources on the server. More...
 
virtual void AftServer::close (const std::string &name)=0
 Close an open sandbox and unbind the transport. More...
 
virtual bool AftServer::find (const std::string &name, AftTransportPtr &transport)=0
 Find transport for named sandbox. More...
 

Detailed Description

Classes used to define the underlying server classes and architecture.

Function Documentation

virtual bool AftServer::alloc ( const std::string &  engineName,
const std::string &  name,
const uint16_t  inputPorts,
const uint16_t  outputPorts 
)
pure virtual

Allocate a new sandbox on the nominated engine.

Parameters
[in]engineNameName of engine to use to allocate sandbox
[in]nameName of sandbox to allocate
[in]inputPortsMaxiumum number of input ports the sandbox can have
[in]outputPortsMaxiumum number of output ports the sandbox can have
Returns
True if the allocation was successful
virtual void AftServer::close ( const std::string &  name)
pure virtual

Close an open sandbox and unbind the transport.

Parameters
[in]nameName of sandbox to close
virtual bool AftServer::find ( const std::string &  name,
AftTransportPtr transport 
)
pure virtual

Find transport for named sandbox.

Parameters
[in]nameName of sandbox
[out]transportReference to transport for sandbox
Returns
True if transport found
virtual bool AftServer::open ( const std::string &  name,
const AftTransportPtr transport,
AftSandboxPtr sandbox 
)
pure virtual

Open an existing sandbox on the server.

Parameters
[in]nameName of sandbox to open
[in]transportTransport that the sandbox open request arrived on
[out]sandboxReference to AftSandbox that was opened if the open() is successful
Returns
True if the open was successful
virtual bool AftServer::release ( const std::string &  name)
pure virtual

Release an existing sandbox and all associated resources on the server.

Parameters
[in]nameName of sandbox to release
Returns
True if the release was successful