ACE/ace/ATM_Stream.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    ATM_Stream.h
   6  *
   7  *  @author Joe Hoffert
   8  */
   9 //=============================================================================
  10
  11 #ifndef ACE_ATM_STREAM_H
  12 #define ACE_ATM_STREAM_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include /**/ "ace/config-all.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #if defined (ACE_HAS_ATM)
  22
  23 #include "ace/ATM_Addr.h"
  24 #include "ace/ATM_Params.h"
  25
  26 #if defined (ACE_WIN32)
  27 #include "ace/SOCK_Stream.h"
  28 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  29 typedef ACE_SOCK_Stream ATM_Stream;
  30 ACE_END_VERSIONED_NAMESPACE_DECL
  31 #else
  32 #include "ace/TLI_Stream.h"
  33 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  34 typedef ACE_TLI_Stream ATM_Stream;
  35 ACE_END_VERSIONED_NAMESPACE_DECL
  36 #endif
  37
  38 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  39
  40 /**
  41  * @class ACE_ATM_Stream
  42  *
  43  * @brief Defines the member functions for ACE_ATM_Stream abstraction.
  44  */
  45 class ACE_Export ACE_ATM_Stream
  46 {
  47 public:
  48   /// Default constructor.
  49   ACE_ATM_Stream (void);
  50
  51   // = ATM-specific open and shutdown operations.
  52   /// open the stream.
  53   int open (ACE_ATM_Params params = ACE_ATM_Params());
  54
  55   /// Close down and release resources.
  56   int close (void);
  57
  58   /// Get the underlying handle.
  59   ACE_HANDLE get_handle (void) const;
  60
  61   /// Get the underlying stream.
  62   ATM_Stream& get_stream (void);
  63
  64   /// Get the name of the connected host.
  65   char* get_peer_name (void) const;
  66
  67   /// Get the VPI and VCI of the stream.
  68   int get_vpi_vci (ACE_UINT16 &vpi,
  69                    ACE_UINT16 &vci) const;
  70
  71   /// Recv an n byte buffer from the connected transport mechanism.
  72   ssize_t recv (void *buf,
  73                 size_t n,
  74                 int *flags = 0) const;
  75
  76   /// Send exactly n bytes to the connected transport mechanism.
  77   ssize_t send_n (const void *buf,
  78                   size_t n,
  79                   int flags) const;
  80
  81   // = Meta-type info
  82   typedef ACE_ATM_Addr PEER_ADDR;
  83
  84   /// Dump the state of an object.
  85   void dump (void) const;
  86
  87   /// Declare the dynamic allocation hooks.
  88   ACE_ALLOC_HOOK_DECLARE;
  89
  90 private:
  91   /// Typedef'd to the appropriate stream mechanism above.
  92   ATM_Stream stream_;
  93 };
  94
  95 ACE_END_VERSIONED_NAMESPACE_DECL
  96
  97 #if defined (__ACE_INLINE__)
  98 #include "ace/ATM_Stream.inl"
  99 #endif /* __ACE_INLINE__ */
 100
 101 #endif /* ACE_HAS_ATM */
 102 #include /**/ "ace/post.h"
 103 #endif /* ACE_ATM_STREAM_H */