class FinderTransport Base class for FinderMessage transport systems. More... Contains pure virtuals Definition #include <finder-transport.hh> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Types

• typedef ref_ptr<FinderTransport> RefPtr
• typedef XorpCallback2<void, const FinderTransport&, const string&>::RefPtr ACallback
• typedef XorpCallback2<void, const FinderTransport&, const FinderMessage::RefPtr&>::RefPtr DCallback
• typedef XorpCallback1<void, const FinderTransport&>::RefPtr FCallback

Public Methods

•  FinderTransport (const ACallback& arrive_cb = callback(no_arrival_callback), const DCallback& departure_cb = callback(no_departure_callback), const FCallback& failure_cb = callback(no_failure_callback), const HMAC* hmac = 0)
• virtual  ~FinderTransport ()
• inline void  set_hmac (const HMAC* hmac)
• inline void  set_arrival_callback (const ACallback& acb)
• inline void  set_departure_callback (const DCallback& dcb)
• inline void  set_failure_callback (const FCallback& fcb)
• inline bool  callbacks_set () const
• inline uint32_t  write (const FinderMessage::RefPtr& m)
• inline const HMAC*  hmac () const

Protected Methods

• virtual void  push_departures ()
• inline void  announce_arrival (const string& s)
• inline void  announce_departure (const FinderMessage::RefPtr& m)
• inline const FinderMessage::RefPtr  departure_head () const
• inline const int  departures_waiting () const
• inline void  fail () const

Protected Static Methods

• static void  no_arrival_callback (const FinderTransport&, const string&)
• static void  no_departure_callback (const FinderTransport&, const FinderMessage::RefPtr&)
• static void  no_failure_callback (const FinderTransport&)

Detailed Description

Base class for FinderMessage transport systems.

Type of callback to be invoked when a FinderMessage arrives. The callback is invoked with the string representation of the FinderMessage (as much information as can be gleaned from the static FinderParser methods - FinderTransport is independent of Parser).

Type of callback to be invoked when a FinderMessage has been sent.

Type of callback to be invoked when the underlying transport fails catastrophically.

Constructor

Parameters:

arrive_cb	callback to be invoked when a FinderMessage arrives.
depart_cb	callback to be invoked when a FinderMessage has been successfully written.
failure_cb	callback to be invoked with underlying transport mechanism fails.
hmac	HMAC object to be used to sign messages.

[virtual]

Install a HMAC object for use when sending messages.

Set arrival callback.

Set departure callback.

Set failure callback.

[const]

Check if all the requisite event callbacks have been set. The transport cannot function correctly without the callbacks being set.

Returns: true if arrival, departure, and failure callbacks have been set (with set_arrival_callback, set_departure_callback, set_failure_callback, or via constructor).

Place FinderMessage on outbound message queue.

Parameters:

m	refpointer to the FinderMessage to be sent.
dcb	callback to be invoked when message successfully written.

Returns: sequence number assigned to message.

[const]

Examine installed hmac.

Returns: pointer HMAC if used, 0 otherwise.

[protected pure virtual]

Method to be implemented by sub-classes to push-start departures.

[protected]

Method that transport implementations call when a message arrives.

[protected]

Method that transport implementations call when a message departs. Notifies client via departure callback that message has been sent and removes message state.

[protected const]

Returns: message at head of departure list.

[protected const]

[protected const]

Method transport implmentations call when transport fails.

[protected static]

Callback function invoked when no user specified arrival callback provided.

[protected static]

Callback function invoked when no user specified departure callback provided.

[protected static]

Callback function invoked when no user specified failure callback provided.