ACE/netsvcs/lib/Time_Request_Reply.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Time_Request_Reply.h
   6  *
   7  *  Define the format used to exchange messages between the
   8  *  ACE time server and clerks.
   9  *
  10  *  @author  Prashant Jain
  11  */
  12 //=============================================================================
  13
  14
  15 #ifndef ACE_TIME_REQUEST_REPLY_H
  16 #define ACE_TIME_REQUEST_REPLY_H
  17 #include /**/ "ace/pre.h"
  18
  19 #include "ace/Time_Value.h"
  20 #include "ace/svc_export.h"
  21
  22 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  23 # pragma once
  24 #endif /* ACE_LACKS_PRAGMA_ONCE */
  25
  26 /**
  27  * @class ACE_Time_Request
  28  *
  29  * @brief Message format for delivering requests to the ACE_Time Server.
  30  *
  31  * This class is implemented to minimize data copying.
  32  * In particular, all marshaling is done in situ...
  33  */
  34 class ACE_Svc_Export ACE_Time_Request
  35 {
  36 public:
  37   enum Constants
  38   {
  39     /// Request message types.
  40     TIME_UPDATE = 01,
  41
  42     /// Class-specific constant values.
  43     MAX_TIME_LEN = MAXPATHLEN + 1
  44   };
  45
  46   /// Default constructor.
  47   ACE_Time_Request ();
  48
  49   /**
  50    * Create a ACE_Time_Request message.
  51    * @param msg_type Type of request.
  52    * @param time Time.
  53    * @param timeout Max time waiting for request.
  54    */
  55   ACE_Time_Request (ACE_INT32 msg_type,
  56                     const time_t time,
  57                     ACE_Time_Value *timeout = 0);
  58
  59   // Get the fixed size of message
  60   ssize_t size () const;
  61
  62   /// Get the type of the message.
  63   ACE_INT32 msg_type () const;
  64
  65   /// Set the type of the message.
  66   void msg_type (ACE_INT32);
  67
  68   /// Get the time
  69   time_t time () const;
  70
  71   // Set the time
  72   void time (time_t t);
  73
  74   /// Get the blocking semantics.
  75   ACE_UINT32 block_forever () const;
  76
  77   ///  Set the blocking semantics.
  78   void block_forever (ACE_UINT32);
  79
  80   /// Get the timeout.
  81   ACE_Time_Value timeout () const;
  82
  83   /// Set the timeout.
  84   void timeout (const ACE_Time_Value& timeout);
  85
  86   /// Encode the message before transmission.
  87   int encode (void *&);
  88
  89   /// Decode message after reception.
  90   int decode ();
  91
  92   /// Print out the values of the message for debugging purposes.
  93   void dump () const;
  94
  95 private:
  96   // = The 5 fields in the <Transfer> struct are transmitted to the server.
  97   // The remaining 2 fields are not tranferred -- they are used only on
  98   // the server-side to simplify lookups.
  99
 100   struct Transfer
 101   {
 102     /// Type of the request (i.e., <TIME_UPDATE>)
 103     ACE_INT32 msg_type_;
 104
 105     /// Indicates if we should block forever.  If 0, then sec_timeout_
 106     /// and usec_timeout_ indicates how long we should wait.
 107     ACE_UINT32 block_forever_;
 108
 109     /// Max seconds willing to wait for name if not blocking forever.
 110     ACE_UINT64 sec_timeout_;
 111
 112     /// Max micro seconds to wait for name if not blocking forever.
 113     ACE_UINT32 usec_timeout_;
 114
 115     /// The data portion contains <time_>
 116     ACE_UINT64 time_;
 117   };
 118
 119   /// Transfer buffer.
 120   Transfer transfer_;
 121
 122   /// Time
 123   time_t time_;
 124 };
 125
 126 #include /**/ "ace/post.h"
 127 #endif /* ACE_TIME_REQUEST_REPLY_H */