summaryrefslogtreecommitdiff
path: root/cpp/src/Ice/Endpoint.h
blob: ff0ed6b23de25d3b925d1e4ee446fe85bb91b2b0 (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
// **********************************************************************
//
// Copyright (c) 2002
// MutableRealms, Inc.
// Huntsville, AL, USA
//
// All Rights Reserved
//
// **********************************************************************

#ifndef ICE_ENDPOINT_H
#define ICE_ENDPOINT_H

#include <Ice/EndpointF.h>
#include <Ice/InstanceF.h>
#include <Ice/TransceiverF.h>
#include <Ice/ConnectorF.h>
#include <Ice/AcceptorF.h>
#include <Ice/Shared.h>

namespace IceInternal
{

class Stream;

const ::Ice::Short UnknownEndpointType = 0;
const ::Ice::Short TcpEndpointType = 1;
const ::Ice::Short SslEndpointType = 2;
const ::Ice::Short UdpEndpointType = 3;

class Endpoint : public ::Ice::Shared
{
public:

    Endpoint() { }

    //
    // Create an endpoint from a string
    //
    static EndpointPtr endpointFromString(const std::string&);
    
    //
    // Unmarshal an endpoint
    //
    static void streamRead(Stream*, EndpointPtr&);
    
    //
    // Marshal the endpoint
    //
    virtual void streamWrite(Stream*) const = 0;

    //
    // Convert the endpoint to its string form
    //
    virtual std::string toString() const = 0;

    //
    // Return the endpoint type
    //
    virtual ::Ice::Short type() const = 0;
    
    //
    // Return true if the endpoint only supports oneway operations.
    //
    virtual bool oneway() const = 0;

    //
    // Return the timeout for the endpoint in milliseconds. 0 means
    // non-blocking, -1 means no timeout.
    //
    virtual ::Ice::Int timeout() const = 0;

    //
    // Return a new endpoint with a different timeout value, provided
    // that timeouts are supported by the endpoint. Otherwise the same
    // endpoint is returned.
    //
    virtual EndpointPtr timeout(::Ice::Int) const = 0;

    //
    // Return true if the endpoint is datagram-based.
    //
    virtual bool datagram() const = 0;

    //
    // Return true if the endpoint is secure.
    //
    virtual bool secure() const = 0;

    //
    // Convenience function for STL algorithms: !datagram() && !secure()
    //
    bool regular() const;

    //
    // Return client- and server-side Transceivers for the endpoint,
    // or null if a TransceiverPtr can only be created by Acceptors or
    // Connectors.
    //
    virtual TransceiverPtr clientTransceiver(const InstancePtr&) const = 0;
    virtual TransceiverPtr serverTransceiver(const InstancePtr&) const = 0;

    //
    // Return Acceptors and Connectors for the endpoint, or null if no
    // Acceptors and Connectors are available.
    //
    virtual ConnectorPtr connector(const InstancePtr&) const = 0;
    virtual AcceptorPtr acceptor(const InstancePtr&) const = 0;

    //
    // Check whether the endpoint is equivalent to a specific
    // Transceiver or Acceptor
    //
    virtual bool equivalent(const TransceiverPtr&) const = 0;
    virtual bool equivalent(const AcceptorPtr&) const = 0;

    //
    // Compare endpoints for sorting purposes
    //
    virtual bool operator==(const Endpoint&) const = 0;
    virtual bool operator!=(const Endpoint&) const = 0;
    virtual bool operator<(const Endpoint&) const = 0;
};

class UnknownEndpoint : public Endpoint
{
public:

    UnknownEndpoint(Stream*);

    virtual void streamWrite(Stream*) const;
    virtual std::string toString() const;
    virtual ::Ice::Short type() const;
    virtual bool oneway() const;
    virtual ::Ice::Int timeout() const;
    virtual EndpointPtr timeout(::Ice::Int) const;
    virtual bool datagram() const;
    virtual bool secure() const;
    virtual TransceiverPtr clientTransceiver(const InstancePtr&) const;
    virtual TransceiverPtr serverTransceiver(const InstancePtr&) const;
    virtual ConnectorPtr connector(const InstancePtr&) const;
    virtual AcceptorPtr acceptor(const InstancePtr&) const;
    virtual bool equivalent(const TransceiverPtr&) const;
    virtual bool equivalent(const AcceptorPtr&) const;

    virtual bool operator==(const Endpoint&) const;
    virtual bool operator!=(const Endpoint&) const;
    virtual bool operator<(const Endpoint&) const;

private:

    //
    // All members are const, because endpoints are immutable.
    //
    const std::vector< ::Ice::Byte> _rawBytes;
};

class TcpEndpoint : public Endpoint
{
public:

    TcpEndpoint(const std::string&, ::Ice::Int, ::Ice::Int);
    TcpEndpoint(const std::string&);
    TcpEndpoint(Stream*);

    virtual void streamWrite(Stream*) const;
    virtual std::string toString() const;
    virtual ::Ice::Short type() const;
    virtual bool oneway() const;
    virtual ::Ice::Int timeout() const;
    virtual EndpointPtr timeout(::Ice::Int) const;
    virtual bool datagram() const;
    virtual bool secure() const;
    virtual TransceiverPtr clientTransceiver(const InstancePtr&) const;
    virtual TransceiverPtr serverTransceiver(const InstancePtr&) const;
    virtual ConnectorPtr connector(const InstancePtr&) const;
    virtual AcceptorPtr acceptor(const InstancePtr&) const;
    virtual bool equivalent(const TransceiverPtr&) const;
    virtual bool equivalent(const AcceptorPtr&) const;

    virtual bool operator==(const Endpoint&) const;
    virtual bool operator!=(const Endpoint&) const;
    virtual bool operator<(const Endpoint&) const;

private:

    //
    // All members are const, because endpoints are immutable.
    //
    const std::string _host;
    const ::Ice::Int _port;
    const ::Ice::Int _timeout;
};

class SslEndpoint : public Endpoint
{
public:

    SslEndpoint(const std::string&, ::Ice::Int, ::Ice::Int);
    SslEndpoint(const std::string&);
    SslEndpoint(Stream*);

    virtual void streamWrite(Stream*) const;
    virtual std::string toString() const;
    virtual ::Ice::Short type() const;
    virtual bool oneway() const;
    virtual ::Ice::Int timeout() const;
    virtual EndpointPtr timeout(::Ice::Int) const;
    virtual bool datagram() const;
    virtual bool secure() const;
    virtual TransceiverPtr clientTransceiver(const InstancePtr&) const;
    virtual TransceiverPtr serverTransceiver(const InstancePtr&) const;
    virtual ConnectorPtr connector(const InstancePtr&) const;
    virtual AcceptorPtr acceptor(const InstancePtr&) const;
    virtual bool equivalent(const TransceiverPtr&) const;
    virtual bool equivalent(const AcceptorPtr&) const;

    virtual bool operator==(const Endpoint&) const;
    virtual bool operator!=(const Endpoint&) const;
    virtual bool operator<(const Endpoint&) const;

private:

    //
    // All members are const, because endpoints are immutable.
    //
    const std::string _host;
    const ::Ice::Int _port;
    const ::Ice::Int _timeout;
};

class UdpEndpoint : public Endpoint
{
public:

    UdpEndpoint(const std::string&, ::Ice::Int);
    UdpEndpoint(const std::string&);
    UdpEndpoint(Stream*);

    virtual void streamWrite(Stream*) const;
    virtual std::string toString() const;
    virtual ::Ice::Short type() const;
    virtual bool oneway() const;
    virtual ::Ice::Int timeout() const;
    virtual EndpointPtr timeout(::Ice::Int) const;
    virtual bool datagram() const;
    virtual bool secure() const;
    virtual TransceiverPtr clientTransceiver(const InstancePtr&) const;
    virtual TransceiverPtr serverTransceiver(const InstancePtr&) const;
    virtual ConnectorPtr connector(const InstancePtr&) const;
    virtual AcceptorPtr acceptor(const InstancePtr&) const;
    virtual bool equivalent(const TransceiverPtr&) const;
    virtual bool equivalent(const AcceptorPtr&) const;

    virtual bool operator==(const Endpoint&) const;
    virtual bool operator!=(const Endpoint&) const;
    virtual bool operator<(const Endpoint&) const;

private:

    //
    // All members are const, because endpoints are immutable.
    //
    const std::string _host;
    const ::Ice::Int _port;
};

}

#endif