BulkDataSenderImpl< TSenderCallback > Class Template Reference

#include <bulkDataSenderImpl.h>

Inheritance diagram for BulkDataSenderImpl< TSenderCallback >:
Inheritance graph
[legend]
Collaboration diagram for BulkDataSenderImpl< TSenderCallback >:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BulkDataSenderImpl (const ACE_CString &name, maci::ContainerServices *containerServices)
virtual ~BulkDataSenderImpl ()
void cleanUp ()
virtual void connect (bulkdata::BulkDataReceiver_ptr receiverObj_p)
virtual void disconnect ()
virtual
AcsBulkdata::BulkDataSender
< TSenderCallback > * 
getSender ()
virtual void startSend ()=0
virtual void paceData ()=0
virtual void stopSend ()=0

Private Attributes

maci::ContainerServicescontainerServices_p
AcsBulkdata::BulkDataSender
< TSenderCallback > 
sender
bulkdata::BulkDataReceiver_ptr receiverObj_m

template<class TSenderCallback = BulkDataSenderDefaultCallback>
class BulkDataSenderImpl< TSenderCallback >


Constructor & Destructor Documentation

template<class TSenderCallback = BulkDataSenderDefaultCallback>
BulkDataSenderImpl< TSenderCallback >::BulkDataSenderImpl ( const ACE_CString &  name,
maci::ContainerServices containerServices 
)

Constructor

Parameters:
poa poa which will activate this and also all other components
name component name
template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual BulkDataSenderImpl< TSenderCallback >::~BulkDataSenderImpl (  )  [virtual]

Destructor


Member Function Documentation

template<class TSenderCallback = BulkDataSenderDefaultCallback>
void BulkDataSenderImpl< TSenderCallback >::cleanUp (  )  [virtual]

Called after the last functional call to the component has finished. The component should then orderly release resources etc. If this method is overwritten in a subclass, the developer has to make sure that all cleanup performed by the implementation of the base class take place. The best way to do this is to call the implementation of the base itself explicitly, as would be done implicitly in a destructor chain.

Returns:
void

Reimplemented from acscomponent::ACSComponentImpl.

Reimplemented in BulkDataSenderDistrImpl< TSenderCallback >.

template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual void BulkDataSenderImpl< TSenderCallback >::connect ( bulkdata::BulkDataReceiver_ptr  receiverObj_p  )  [virtual]

Negotiate and initialize connection with the Sender object.

Parameters:
receiver reference of the Receiver Component.
Exceptions:
ACSBulkDataError::AVConnectErrorEx 
Returns:
void

template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual void BulkDataSenderImpl< TSenderCallback >::disconnect (  )  [virtual]
Exceptions:
ACSBulkDataError::AVDisconnectErrorEx 
template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual AcsBulkdata::BulkDataSender<TSenderCallback>* BulkDataSenderImpl< TSenderCallback >::getSender (  )  [inline, virtual]
template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual void BulkDataSenderImpl< TSenderCallback >::paceData (  )  [pure virtual]

Sends data to the Receiver calling the receive_frame() method on the Receiver side. This method must be overriden by the user to send his own data.

Parameters:
size buffer size of the sent data.
Exceptions:
ACSBulkDataError::AVPaceDataErrorEx 
Returns:
void

Implemented in BulkDataSenderDistrImpl< TSenderCallback >, BulkDataSenderEx1Impl, BulkDataSenderEx2Impl, BulkDataSenderEx3Impl, BulkDataSenderNotifImpl, BulkDataSenderPerfImpl, and BulkDataSenderThreadImpl.

template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual void BulkDataSenderImpl< TSenderCallback >::startSend (  )  [pure virtual]

Calls the Receiver handle_start() method once the connection is established.

Exceptions:
ACSBulkDataError::AVStartSendErrorEx 
Returns:
void

Implemented in BulkDataSenderDistrImpl< TSenderCallback >, BulkDataSenderEx1Impl, BulkDataSenderEx2Impl, BulkDataSenderEx3Impl, BulkDataSenderNotifImpl, BulkDataSenderPerfImpl, and BulkDataSenderThreadImpl.

template<class TSenderCallback = BulkDataSenderDefaultCallback>
virtual void BulkDataSenderImpl< TSenderCallback >::stopSend (  )  [pure virtual]

Calls the Receiver handle_stop() method.

Exceptions:
ACSBulkDataError::AVStopSendErrorEx 
Returns:
void

Implemented in BulkDataSenderDistrImpl< TSenderCallback >, BulkDataSenderEx1Impl, BulkDataSenderEx2Impl, BulkDataSenderEx3Impl, BulkDataSenderNotifImpl, BulkDataSenderPerfImpl, and BulkDataSenderThreadImpl.


Member Data Documentation

template<class TSenderCallback = BulkDataSenderDefaultCallback>
maci::ContainerServices* BulkDataSenderImpl< TSenderCallback >::containerServices_p [private]

Pointer to the dataProtocol on which the send_frame(...) method is called in order to actually send data.

template<class TSenderCallback = BulkDataSenderDefaultCallback>
bulkdata::BulkDataReceiver_ptr BulkDataSenderImpl< TSenderCallback >::receiverObj_m [private]
template<class TSenderCallback = BulkDataSenderDefaultCallback>
AcsBulkdata::BulkDataSender<TSenderCallback> BulkDataSenderImpl< TSenderCallback >::sender [private]

The documentation for this class was generated from the following file:

Generated by  doxygen 1.6.2