Ice 3.7 Slice API Reference
Loading...
Searching...
No Matches
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>
23#include <Ice/EndpointF.ice>
24
25#ifndef __SLICE2JAVA_COMPAT__
26[["java:package:com.zeroc"]]
27#endif
28
29["objc:prefix:ICE"]
30module Ice
31{
32
38const short TCPEndpointType = 1;
39
45const short SSLEndpointType = 2;
46
52const short UDPEndpointType = 3;
53
59const short WSEndpointType = 4;
60
66const short WSSEndpointType = 5;
67
73const short BTEndpointType = 6;
74
80const short BTSEndpointType = 7;
81
87const short iAPEndpointType = 8;
88
94const short iAPSEndpointType = 9;
95
96#if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
102local class EndpointInfo
103{
111
119
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"]
162local interface Endpoint
163{
171 ["cpp:const", "cpp:noexcept", "swift:noexcept"] string toString();
172
180 ["cpp:const", "cpp:noexcept", "swift:noexcept"] EndpointInfo getInfo();
181}
182
190local class IPEndpointInfo extends EndpointInfo
191{
197 string host;
198
204 int port;
205
212}
213
222{
223}
224
233{
240
247}
248
254local class WSEndpointInfo extends EndpointInfo
255{
261 string resource;
262}
263
288
289#endif
290
291}
Base class providing access to the endpoint details.
Definition Endpoint.ice:103
int timeout
The timeout for the endpoint in milliseconds.
Definition Endpoint.ice:118
EndpointInfo underlying
The information of the underyling endpoint of null if there's no underlying endpoint.
Definition Endpoint.ice:110
bool datagram()
Returns true if this endpoint is a datagram endpoint.
bool secure()
Returns true if this endpoint is a secure endpoint.
bool compress
Specifies whether or not compression should be used if available when using this endpoint.
Definition Endpoint.ice:126
short type()
Returns the type of the endpoint.
Provides access to the address details of a IP endpoint.
Definition Endpoint.ice:191
int port
The port number.
Definition Endpoint.ice:204
string host
The host or address configured with the endpoint.
Definition Endpoint.ice:197
string sourceAddress
The source IP address.
Definition Endpoint.ice:211
Provides access to the details of an opaque endpoint.
Definition Endpoint.ice:272
EncodingVersion rawEncoding
The encoding version of the opaque endpoint (to decode or encode the rawBytes).
Definition Endpoint.ice:279
ByteSeq rawBytes
The raw encoding of the opaque endpoint.
Definition Endpoint.ice:286
Provides access to a TCP endpoint information.
Definition Endpoint.ice:222
Provides access to an UDP endpoint information.
Definition Endpoint.ice:233
int mcastTtl
The multicast time-to-live (or hops).
Definition Endpoint.ice:246
string mcastInterface
The multicast interface.
Definition Endpoint.ice:239
Provides access to a WebSocket endpoint information.
Definition Endpoint.ice:255
string resource
The URI configured with the endpoint.
Definition Endpoint.ice:261
The user-level interface to an endpoint.
Definition Endpoint.ice:163
EndpointInfo getInfo()
Returns the endpoint information.
string toString()
Return a string representation of the endpoint.
The Ice core library.
Definition BuiltinSequences.ice:27
const short SSLEndpointType
Uniquely identifies SSL endpoints.
Definition Endpoint.ice:45
const short TCPEndpointType
Uniquely identifies TCP endpoints.
Definition Endpoint.ice:38
const short WSSEndpointType
Uniquely identifies SSL-based WebSocket endpoints.
Definition Endpoint.ice:66
const short UDPEndpointType
Uniquely identifies UDP endpoints.
Definition Endpoint.ice:52
const short BTSEndpointType
Uniquely identifies SSL Bluetooth endpoints.
Definition Endpoint.ice:80
const short WSEndpointType
Uniquely identifies TCP-based WebSocket endpoints.
Definition Endpoint.ice:59
const short iAPSEndpointType
Uniquely identifies SSL iAP-based endpoints.
Definition Endpoint.ice:94
sequence< byte > ByteSeq
A sequence of bytes.
Definition BuiltinSequences.ice:33
const short iAPEndpointType
Uniquely identifies iAP-based endpoints.
Definition Endpoint.ice:87
const short BTEndpointType
Uniquely identifies Bluetooth endpoints.
Definition Endpoint.ice:73
A version structure for the encoding version.
Definition Version.ice:46