Ice 3.7 Slice API Reference
Endpoint.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICE_API"]]
8 [["cpp:doxygen:include:Ice/Ice.h"]]
9 [["cpp:header-ext:h"]]
10 
11 [["ice-prefix"]]
12 
13 [["js:module:ice"]]
14 [["js:cjs-module"]]
15 
16 [["objc:dll-export:ICE_API"]]
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:Ice"]]
20 
21 #include <Ice/Version.ice>
22 #include <Ice/BuiltinSequences.ice>
23 #include <Ice/EndpointF.ice>
24 
25 #ifndef __SLICE2JAVA_COMPAT__
26 [["java:package:com.zeroc"]]
27 #endif
28 
29 ["objc:prefix:ICE"]
30 module Ice
31 {
32 
38 const short TCPEndpointType = 1;
39 
45 const short SSLEndpointType = 2;
46 
52 const short UDPEndpointType = 3;
53 
59 const short WSEndpointType = 4;
60 
66 const short WSSEndpointType = 5;
67 
73 const short BTEndpointType = 6;
74 
80 const short BTSEndpointType = 7;
81 
87 const short iAPEndpointType = 8;
88 
94 const short iAPSEndpointType = 9;
95 
96 #if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
97 
102 local class EndpointInfo
103 {
111 
118  int timeout;
119 
126  bool compress;
127 
135  ["cpp:const", "cpp:noexcept", "swift:noexcept"] short type();
136 
144  ["cpp:const", "cpp:noexcept", "swift:noexcept"] bool datagram();
145 
153  ["cpp:const", "cpp:noexcept", "swift:noexcept"] bool secure();
154 }
155 
161 ["cpp:comparable", "js:comparable", "swift:inherits:Swift.CustomStringConvertible"]
162 local interface Endpoint
163 {
171  ["cpp:const", "cpp:noexcept", "swift:noexcept"] string toString();
172 
180  ["cpp:const", "cpp:noexcept", "swift:noexcept"] EndpointInfo getInfo();
181 }
182 
190 local class IPEndpointInfo extends EndpointInfo
191 {
197  string host;
198 
204  int port;
205 
212 }
213 
221 local class TCPEndpointInfo extends IPEndpointInfo
222 {
223 }
224 
232 local class UDPEndpointInfo extends IPEndpointInfo
233 {
240 
246  int mcastTtl;
247 }
248 
254 local class WSEndpointInfo extends EndpointInfo
255 {
261  string resource;
262 }
263 
271 local class OpaqueEndpointInfo extends EndpointInfo
272 {
280 
287 }
288 
289 #endif
290 
291 }
Ice::EndpointInfo::type
short type()
Returns the type of the endpoint.
Ice::ByteSeq
sequence< byte > ByteSeq
A sequence of bytes.
Definition: BuiltinSequences.ice:33
Ice::iAPSEndpointType
const short iAPSEndpointType
Uniquely identifies SSL iAP-based endpoints.
Definition: Endpoint.ice:94
Ice::EndpointInfo::secure
bool secure()
Returns true if this endpoint is a secure endpoint.
BuiltinSequences.ice
Ice::IPEndpointInfo::sourceAddress
string sourceAddress
The source IP address.
Definition: Endpoint.ice:211
Ice::IPEndpointInfo::port
int port
The port number.
Definition: Endpoint.ice:204
Ice::WSEndpointInfo
Provides access to a WebSocket endpoint information.
Definition: Endpoint.ice:255
Ice::EndpointInfo::timeout
int timeout
The timeout for the endpoint in milliseconds.
Definition: Endpoint.ice:118
Ice::EndpointInfo::underlying
EndpointInfo underlying
The information of the underyling endpoint of null if there's no underlying endpoint.
Definition: Endpoint.ice:110
Ice::EndpointInfo::datagram
bool datagram()
Returns true if this endpoint is a datagram endpoint.
Ice::IPEndpointInfo::host
string host
The host or address configured with the endpoint.
Definition: Endpoint.ice:197
Ice::BTSEndpointType
const short BTSEndpointType
Uniquely identifies SSL Bluetooth endpoints.
Definition: Endpoint.ice:80
Ice::BTEndpointType
const short BTEndpointType
Uniquely identifies Bluetooth endpoints.
Definition: Endpoint.ice:73
Ice::UDPEndpointType
const short UDPEndpointType
Uniquely identifies UDP endpoints.
Definition: Endpoint.ice:52
Ice::WSEndpointType
const short WSEndpointType
Uniquely identifies TCP-based WebSocket endpoints.
Definition: Endpoint.ice:59
Ice::EndpointInfo::compress
bool compress
Specifies whether or not compression should be used if available when using this endpoint.
Definition: Endpoint.ice:126
Ice::TCPEndpointInfo
Provides access to a TCP endpoint information.
Definition: Endpoint.ice:222
Ice::EncodingVersion
A version structure for the encoding version.
Definition: Version.ice:46
Ice::WSSEndpointType
const short WSSEndpointType
Uniquely identifies SSL-based WebSocket endpoints.
Definition: Endpoint.ice:66
Ice::OpaqueEndpointInfo::rawEncoding
EncodingVersion rawEncoding
The encoding version of the opaque endpoint (to decode or encode the rawBytes).
Definition: Endpoint.ice:279
Ice::SSLEndpointType
const short SSLEndpointType
Uniquely identifies SSL endpoints.
Definition: Endpoint.ice:45
Ice::WSEndpointInfo::resource
string resource
The URI configured with the endpoint.
Definition: Endpoint.ice:261
Ice::UDPEndpointInfo::mcastInterface
string mcastInterface
The multicast interface.
Definition: Endpoint.ice:239
Ice::EndpointInfo
Base class providing access to the endpoint details.
Definition: Endpoint.ice:103
Ice::Endpoint
The user-level interface to an endpoint.
Definition: Endpoint.ice:163
Ice::OpaqueEndpointInfo
Provides access to the details of an opaque endpoint.
Definition: Endpoint.ice:272
Ice::iAPEndpointType
const short iAPEndpointType
Uniquely identifies iAP-based endpoints.
Definition: Endpoint.ice:87
Ice::TCPEndpointType
const short TCPEndpointType
Uniquely identifies TCP endpoints.
Definition: Endpoint.ice:38
Ice
The Ice core library.
Definition: BuiltinSequences.ice:27
Version.ice
Ice::UDPEndpointInfo
Provides access to an UDP endpoint information.
Definition: Endpoint.ice:233
Ice::Endpoint::getInfo
EndpointInfo getInfo()
Returns the endpoint information.
Ice::UDPEndpointInfo::mcastTtl
int mcastTtl
The multicast time-to-live (or hops).
Definition: Endpoint.ice:246
Ice::IPEndpointInfo
Provides access to the address details of a IP endpoint.
Definition: Endpoint.ice:191
Ice::OpaqueEndpointInfo::rawBytes
ByteSeq rawBytes
The raw encoding of the opaque endpoint.
Definition: Endpoint.ice:286
Ice::Endpoint::toString
string toString()
Return a string representation of the endpoint.
EndpointF.ice