AcsBulkdata::BulkDataNTSenderStream

NAME
SYNOPSIS
Member Typedef Documentation
Constructor & Destructor Documentation
Member Function Documentation
Friends And Related Function Documentation
Member Data Documentation
Author

NAME

AcsBulkdata::BulkDataNTSenderStream −

SYNOPSIS

#include <bulkDataNTSenderStream.h>

Inherits AcsBulkdata::BulkDataNTStream.

Public Member Functions

BulkDataNTSenderStream (const char *name, const SenderStreamConfiguration &cfg=SenderStreamConfiguration())

virtual ~BulkDataNTSenderStream ()

BulkDataNTSenderFlow * createFlow (const char *flowName, const SenderFlowConfiguration &cfg=SenderFlowConfiguration(), BulkDataNTSenderFlowCallback *cb=0, bool releaseCB=false)

void createMultipleFlowsFromConfig (const char *config)

BulkDataNTSenderFlow * getFlow (const char *flowName)

bool existFlow (const char *flowName)

std::vector< std::string > getFlowNames ()

unsigned int getFlowNumber ()

Protected Types

typedef std::map< std::string, BulkDataNTSenderFlow * > SenderFlowMap

Protected Member Functions

virtual void removeFlowFromMap (const char *flow)

BulkDataNTSenderStream ()

disable default - empty constructor

void operator= (const BulkDataNTSenderStream &)

ALMA C++ coding standards state assignment operators should be disabled.

BulkDataNTSenderStream (const BulkDataNTSenderStream &)

ALMA C++ coding standards state copy constructors should be disabled.

Protected Attributes

SenderFlowMap senderFlows_m

bool notRemoveFromMap_m

Friends

class BulkDataNTSenderFlow

Member Typedef Documentation

typedef std::map<std::string, BulkDataNTSenderFlow*> AcsBulkdata::BulkDataNTSenderStream::SenderFlowMap [protected]

Constructor & Destructor Documentation

AcsBulkdata::BulkDataNTSenderStream::BulkDataNTSenderStream (const char * name, const SenderStreamConfiguration & cfg = SenderStreamConfiguration()) Sender Stream constructor.

Parameters:

name name of the sender stream that should be constructed
cfg(optional)
sender stream configuration

Exceptions:

StreamCreateProblemExImpl

virtual AcsBulkdata::BulkDataNTSenderStream::~BulkDataNTSenderStream () [virtual] Sender stream destruction which destroys also all created flows.

AcsBulkdata::BulkDataNTSenderStream::BulkDataNTSenderStream () [protected]

disable default - empty constructor

AcsBulkdata::BulkDataNTSenderStream::BulkDataNTSenderStream (const BulkDataNTSenderStream &) [protected]

ALMA C++ coding standards state copy constructors should be disabled.

Member Function Documentation

BulkDataNTSenderFlow* AcsBulkdata::BulkDataNTSenderStream::createFlow (const char * flowName, const SenderFlowConfiguration & cfg = SenderFlowConfiguration(), BulkDataNTSenderFlowCallback * cb = 0, bool releaseCB = false) The method creates a flow an the sender stream

Parameters:

flowName name of the flow that should be created
cfg
(optional) sender flow configuration
cb
(optional) Sender flow status callback
releaseCB
should be the callback released when the flow is destroyed

Returns:

pointer to created sender flow object

void AcsBulkdata::BulkDataNTSenderStream::createMultipleFlowsFromConfig (const char * config)

bool AcsBulkdata::BulkDataNTSenderStream::existFlow (const char * flowName) Method just to check if a flow exists in the stream.

Parameters:

flowName the name of the flow

Returns:

true if the flow with name flowName exists in the stream otherwise false

BulkDataNTSenderFlow* AcsBulkdata::BulkDataNTSenderStream::getFlow (const char * flowName) It returns pointer to Sender Flow with the specified name

Parameters:

flowName the name of the flow

Returns:

sender flow if present in the stream, otherwise exception

Exceptions:

FlowNotExistExImpl

std::vector<std::string> AcsBulkdata::BulkDataNTSenderStream::getFlowNames () Get the names of the all flows created by the stream

Returns:

vector<string>

unsigned int AcsBulkdata::BulkDataNTSenderStream::getFlowNumber () Returns number of flows in the stream.

Returns:

unsigned int - number of flows

void AcsBulkdata::BulkDataNTSenderStream::operator= (const BulkDataNTSenderStream &) [protected]

ALMA C++ coding standards state assignment operators should be disabled.

virtual void AcsBulkdata::BulkDataNTSenderStream::removeFlowFromMap (const char * flow) [protected, virtual]

Implements AcsBulkdata::BulkDataNTStream.

Friends And Related Function Documentation

friend class BulkDataNTSenderFlow [friend]

Member Data Documentation

bool AcsBulkdata::BulkDataNTSenderStream::notRemoveFromMap_m [protected]

SenderFlowMap AcsBulkdata::BulkDataNTSenderStream::senderFlows_m [protected]

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.