Document return values
[ACE_TAO.git] / ACE / ace / LSOCK_Dgram.h
blob79d52e0ecb8d1c1e2e74e3bbb6ae5da961301bf3
1 // -*- C++ -*-
3 //=============================================================================
4 /**
5 * @file LSOCK_Dgram.h
7 * @author Doug Schmidt
8 */
9 //=============================================================================
12 #ifndef ACE_LOCAL_SOCK_DGRAM_H
13 #define ACE_LOCAL_SOCK_DGRAM_H
14 #include /**/ "ace/pre.h"
16 #include /**/ "ace/config-all.h"
18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
19 # pragma once
20 #endif /* ACE_LACKS_PRAGMA_ONCE */
22 #if !defined (ACE_LACKS_UNIX_DOMAIN_SOCKETS)
24 #include "ace/SOCK_Dgram.h"
25 #include "ace/LSOCK.h"
27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
29 /**
30 * @class ACE_LSOCK_Dgram
32 * @brief Create a Local ACE_SOCK datagram.
34 class ACE_Export ACE_LSOCK_Dgram : public ACE_SOCK_Dgram, public ACE_LSOCK
36 public:
37 /// Default constructor.
38 ACE_LSOCK_Dgram ();
40 /// Initiate a local dgram.
41 ACE_LSOCK_Dgram (const ACE_Addr &local,
42 int protocol_family = PF_UNIX,
43 int protocol = 0);
45 /// Initiate a local dgram.
46 int open (const ACE_Addr &local,
47 int protocol_family = PF_UNIX,
48 int protocol = 0);
50 /// Get handle.
51 ACE_HANDLE get_handle () const;
53 /// Set handle.
54 void set_handle (ACE_HANDLE);
56 /// Dump the state of an object.
57 void dump () const;
59 /// Declare the dynamic allocation hooks.
60 ACE_ALLOC_HOOK_DECLARE;
63 ACE_END_VERSIONED_NAMESPACE_DECL
65 #if defined (__ACE_INLINE__)
66 #include "ace/LSOCK_Dgram.inl"
67 #endif /* __ACE_INLINE__ */
69 #endif /* ACE_LACKS_UNIX_DOMAIN_SOCKETS */
70 #include /**/ "ace/post.h"
71 #endif /* ACE_LOCAL_SOCK_DGRAM_H */