aboutsummaryrefslogtreecommitdiff
path: root/dep/ACE_wrappers/ace/SOCK.h
diff options
context:
space:
mode:
Diffstat (limited to 'dep/ACE_wrappers/ace/SOCK.h')
-rw-r--r--dep/ACE_wrappers/ace/SOCK.h25
1 files changed, 25 insertions, 0 deletions
diff --git a/dep/ACE_wrappers/ace/SOCK.h b/dep/ACE_wrappers/ace/SOCK.h
index ea44671ef71..3d8b13cf24f 100644
--- a/dep/ACE_wrappers/ace/SOCK.h
+++ b/dep/ACE_wrappers/ace/SOCK.h
@@ -1,4 +1,5 @@
/* -*- C++ -*- */
+
//=============================================================================
/**
* @file SOCK.h
@@ -8,17 +9,23 @@
* @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
*/
//=============================================================================
+
#ifndef ACE_SOCK_H
#define ACE_SOCK_H
#include /**/ "ace/pre.h"
+
#include /**/ "ace/ACE_export.h"
+
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
+
#include "ace/Addr.h"
#include "ace/IPC_SAP.h"
#include "ace/OS_NS_stropts.h"
+
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
+
/**
* @class ACE_SOCK
*
@@ -34,16 +41,19 @@ ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Export ACE_SOCK : public ACE_IPC_SAP
{
public:
+
/// Wrapper around the @c setsockopt system call.
int set_option (int level,
int option,
void *optval,
int optlen) const;
+
/// Wrapper around the @c getsockopt system call.
int get_option (int level,
int option,
void *optval,
int *optlen) const;
+
/**
* Close the socket.
* This method also sets the object's handle value to ACE_INVALID_HANDLE.
@@ -52,24 +62,30 @@ public:
* was already ACE_INVALID_HANDLE.
*/
int close (void);
+
/// Return the local endpoint address in the referenced <ACE_Addr>.
/// Returns 0 if successful, else -1.
int get_local_addr (ACE_Addr &) const;
+
/**
* Return the address of the remotely connected peer (if there is
* one), in the referenced ACE_Addr. Returns 0 if successful, else
* -1.
*/
int get_remote_addr (ACE_Addr &) const;
+
/// Dump the state of an object.
void dump (void) const;
+
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
+
/// Wrapper around the BSD-style @c socket system call (no QoS).
int open (int type,
int protocol_family,
int protocol,
int reuse_addr);
+
/// Wrapper around the QoS-enabled @c WSASocket function.
int open (int type,
int protocol_family,
@@ -78,13 +94,16 @@ public:
ACE_SOCK_GROUP g,
u_long flags,
int reuse_addr);
+
protected:
+
/// Constructor with arguments to call the BSD-style @c socket system
/// call (no QoS).
ACE_SOCK (int type,
int protocol_family,
int protocol = 0,
int reuse_addr = 0);
+
/// Constructor with arguments to call the QoS-enabled @c WSASocket
/// function.
ACE_SOCK (int type,
@@ -94,9 +113,11 @@ protected:
ACE_SOCK_GROUP g,
u_long flags,
int reuse_addr);
+
/// Default constructor is protected to prevent instances of this class
/// from being defined.
ACE_SOCK (void);
+
/// Protected destructor.
/**
* Not a virtual destructor. Protected destructor to prevent
@@ -104,11 +125,15 @@ protected:
* pointer/reference.
*/
~ACE_SOCK (void);
+
};
+
ACE_END_VERSIONED_NAMESPACE_DECL
+
#if defined (__ACE_INLINE__)
#include "ace/SOCK.inl"
#endif /* __ACE_INLINE__ */
+
#include /**/ "ace/post.h"
#endif /* ACE_SOCK_H */