diff options
Diffstat (limited to 'TAO/tao/Transport_Mux_Strategy.h')
| -rw-r--r-- | TAO/tao/Transport_Mux_Strategy.h | 80 |
1 files changed, 41 insertions, 39 deletions
diff --git a/TAO/tao/Transport_Mux_Strategy.h b/TAO/tao/Transport_Mux_Strategy.h index 094974b61e2..447f40ce344 100644 --- a/TAO/tao/Transport_Mux_Strategy.h +++ b/TAO/tao/Transport_Mux_Strategy.h @@ -1,15 +1,15 @@ // This may look like C, but it's really -*- C++ -*- -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = AUTHOR -// Alexander Babu Arulanthu <alex@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Transport_Mux_Strategy.h + * + * $Id$ + * + * @author Alexander Babu Arulanthu <alex@cs.wustl.edu> + */ +//============================================================================= + #ifndef TAO_TRANSPORT_MUX_STRATEGY_H #define TAO_TRANSPORT_MUX_STRATEGY_H @@ -25,46 +25,48 @@ class TAO_Reply_Dispatcher; class TAO_Transport; class TAO_Pluggable_Reply_Params; +/** + * @class TAO_Transport_Mux_Strategy + * + * @brief Strategy to determine whether the connection should be + * multiplexed for multiple requests or it is exclusive for a + * single request at a time. + * + */ class TAO_Export TAO_Transport_Mux_Strategy { - // = TITLE - // - // Strategy to determine whether the connection should be - // multiplexed for multiple requests or it is exclusive for a - // single request at a time. - // - // = DESCRIPTION - // public: + /// Base class constructor. TAO_Transport_Mux_Strategy (TAO_Transport *transport); - // Base class constructor. + /// Base class destructor. virtual ~TAO_Transport_Mux_Strategy (void); - // Base class destructor. + /// Generate and return an unique request id for the current + /// invocation. virtual CORBA::ULong request_id (void) = 0; - // Generate and return an unique request id for the current - // invocation. // = Bind and Find methods for the <Request ID, ReplyDispatcher> // pairs. + /// Bind the dispatcher with the request id. Commonalities in the + /// derived class implementations is kept here. virtual int bind_dispatcher (CORBA::ULong request_id, TAO_Reply_Dispatcher *rd); - // Bind the dispatcher with the request id. Commonalities in the - // derived class implementations is kept here. + /** + * Unbind the dispatcher, the client is no longer waiting for the + * request, for example, because the request timedout. + * The strategy can (must) cleanup any resources associated with the + * request. + * A later reply for that request should be ignored. + */ virtual void unbind_dispatcher (CORBA::ULong request_id); - // Unbind the dispatcher, the client is no longer waiting for the - // request, for example, because the request timedout. - // The strategy can (must) cleanup any resources associated with the - // request. - // A later reply for that request should be ignored. + /// Dispatch the reply for <request_id>, cleanup any resources + /// allocated for that request. virtual int dispatch_reply (TAO_Pluggable_Reply_Params ¶ms) = 0; - // Dispatch the reply for <request_id>, cleanup any resources - // allocated for that request. // = "Factory methods" to obtain the CDR stream, in the Muxed case // the factory simply allocates a new one, in the Exclusive case @@ -76,21 +78,21 @@ public: // virtual void destroy_message_state (TAO_GIOP_Message_State *) = 0; // Destroy a CDR stream. + /// Request has been just sent, but the reply is not received. Idle + /// the transport now. virtual int idle_after_send (void) = 0; - // Request has been just sent, but the reply is not received. Idle - // the transport now. + /// Request is sent and the reply is received. Idle the transport + /// now. virtual int idle_after_reply (void) = 0; - // Request is sent and the reply is received. Idle the transport - // now. + /// The transport object has closed the connection, inform all Reply + /// dispatchers and waiting strategies. virtual void connection_closed (void) = 0; - // The transport object has closed the connection, inform all Reply - // dispatchers and waiting strategies. protected: + /// Cache the transport reference. TAO_Transport *transport_; - // Cache the transport reference. }; #include "ace/post.h" |