summaryrefslogtreecommitdiff
path: root/ace/SSL/SSL_SOCK.h
blob: a205f0f48dfd5fc51d85dc0ccf225caa08fdaf1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
// -*- C++ -*-
// $Id$

//============================================================================
//
// = LIBRARY
//    ACE_SSL
//
// = FILENAME
//    SSL_SOCK.h
//
// = AUTHOR
//    Ossama Othman <ossama@ece.uci.edu>
//
//============================================================================

#ifndef ACE_SSL_SOCK_H
#define ACE_SSL_SOCK_H

#include "ace/pre.h"

#include "ace/SOCK.h"

#include "ace/SSL/SSL_Export.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */


#if defined (ACE_HAS_TEMPLATE_TYPEDEFS)
# define ACE_SSL_SOCK_ACCEPTOR ACE_SSL_SOCK_Acceptor
# define ACE_SSL_SOCK_CONNECTOR ACE_SSL_SOCK_Connector
# define ACE_SSL_SOCK_STREAM ACE_SSL_SOCK_Stream
#else
# define ACE_SSL_SOCK_ACCEPTOR ACE_SSL_SOCK_Acceptor, ACE_INET_Addr
# define ACE_SSL_SOCK_CONNECTOR ACE_SSL_SOCK_Connector, ACE_INET_Addr
# define ACE_SSL_SOCK_STREAM ACE_SSL_SOCK_Stream, ACE_INET_Addr
#endif /* ACE_HAS_TEMPLATE_TYPEDEFS */

class ACE_SSL_Export ACE_SSL_SOCK : public ACE_SOCK
{
  // = TITLE
  //     An abstract class that forms the basis for more specific
  //     classes, such as <ACE_SSL_SOCK_Acceptor> and
  //     <ACE_SSL_SOCK_Stream>.
  //     Do not instantiate this class.
  //
  // = DESCRIPTION
  //    This class provides functions that are common to all of the
  //    <ACE_SSL_SOCK_*> classes. <ACE_SSL_SOCK> provides the ability
  //    to get and set socket options, get the local and remote
  //    addresses, and close the socket.
public:

  ~ACE_SSL_SOCK (void);
  // Default destructor.

  // Override ACE_SOCK base class implementations with these SSL
  // specific ones.

  int set_option (int level,
                  int option,
                  void *optval,
                  int optlen) const;
  int get_option (int level,
                  int option,
                  void *optval,
                  int *optlen) const;
  int enable (int value) const;
  int disable (int value) const;
  void set_handle (ACE_HANDLE);
  ACE_HANDLE get_handle (void) const;
  int control (int cmd, void *arg) const;

protected:

  ACE_SSL_SOCK (void);
  // Default constructor is private to prevent instances of this class
  // from being defined.
};

#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "ace/SSL/SSL_SOCK.i"
#endif /* ACE_LACKS_INLINE_FUNCTIONS */

#include "ace/post.h"

#endif /* ACE_SSL_SOCK_H */