summaryrefslogtreecommitdiff
path: root/ace/CLASSIX/Connector.h
blob: c7fedc395981a27bd47b0b2cfcef4b14c8dec548 (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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//     ace
// 
// = FILENAME
//     CLASSIX/CLD_Connector.h
//
// = AUTHOR(S)
//     Wei Chiang
// 
// = COPYRIGHT
//     Copyright 1998 Nokia Telecommunications
//
// ============================================================================

#ifndef ACE_CLASSIX_CLD_CONNECTOR_H
#define ACE_CLASSIX_CLD_CONNECTOR_H

#include "CLASSIX/Stream.h"

class ACE_CLASSIX_CLD_Connector
{
  // = TITLE
  //     Defines an CLASSIX IPC connectionless connection factory for the
  //     template methods in <ACE_Connector>.
  //
  // = DESCRIPTION
  //     This is used when a client needs to communicate with a server
  //     whose SAP address is known beforehand.
  //     
  //     Although there is a connection
  //     procedure, no connection is actually taken place
  //     between the client and server, since Chorus IPC does not have
  //     connection semantics.
  //     The connect procedure is necessary for
  //     compatibility with <ACE_SOCK_Connector> class.
  //     
  //     This class will simplify the client's
  //     program, since it provides connection-like communication
  //     mechanism.
  //
  // = NOTES
  //     The server in this case trusts everyone who lands on the
  //     server's SAP.
  //     
  // = SEE ALSO
  //   ACE_CLASSIX_COD_Connector
public:
  // =  Connect options
  enum OPTIONS
  {
    // Do not enable the local SAP
    // (so that the Reactor will not monitor the port)
    ENABLE	= 0x1
  };

  // = Initialization routines.
  ACE_CLASSIX_CLD_Connector (void);
  // Default constructor.

  ACE_CLASSIX_CLD_Connector (ACE_CLASSIX_Stream &new_stream, 
                             const ACE_Addr &remote_sap 
                             = ACE_Addr::sap_any,
                             ACE_Time_Value *timeout = 0,
                             const ACE_Addr &local_sap = ACE_Addr::sap_any,
                             int reuse_addr = 0,
                             int flags = 0,
                             int perms = 0,
                             int protocol_family 
                             = ACE_CLASSIX_Addr::AF_CLASSIX, 
                             int protocol = 0);
  // Emulates connection semantics so that it can be plugged into
  // <ACE_Connector>
  // Actively connect local SAP and remote SAP togeter.
  // Produce a <new_stream> if things go well.
  //
  // <remote_sap> is the peer's address. In ACE_SOCK_Connector it refers to
  // the acceptor's address.  In connectionless mode, we do not have
  // an acceptor.  The <remote_sap> address will be copied to the new stream
  // if things goes well.
  // 
  // If <local_sap> refers to any address, a port will be
  // allocated and will be used as a local SAP.
  //
  // The rest parameters are there so that this class can be plugged into
  // <ACE_Connector>.

  virtual int connect (ACE_CLASSIX_Stream &new_stream, 
                       const ACE_Addr &remote_sap = ACE_Addr::sap_any,
                       ACE_Time_Value *timeout = 0,
                       const ACE_Addr &local_sap = ACE_Addr::sap_any,
                       int reuse_addr = 0,
                       int flags = 0,
                       int perms = 0,
                       int protocol_family = ACE_CLASSIX_Addr::AF_CLASSIX,
                       int protocol = 0); 

  // Factory method used in <ACE_Connector>::connect_svc_handler()

  // Initialization method when default constructor is used.
  // See the comments for the corresponding constructor 
    
  virtual int reset_new_handle (ACE_HANDLE handle);
  // Factory method used in ACE_Connector::handle_output().
  // Meant for resetting any event associations on this handle
  // Does nothig.

  // = HELPER
  void dump(void) const;

private:
 
  ACE_CLASSIX_CLD_Connector(ACE_CLASSIX_CLD_Connector const&);
  ACE_CLASSIX_CLD_Connector const& operator=(ACE_CLASSIX_CLD_Connector const&);
};

/* ------------------------------------------------------------------------- */

#if defined (__ACE_INLINE__)
#include "CLASSIX/CLD_Connector.i"
#endif /* __ACE_INLINE__ */

#endif /* ACE_CLASSIX_CLD_CONNECTOR_H */