Ice 3.7 Slice API Reference
|
Go to the documentation of this file.
7 [[
"cpp:dll-export:ICE_API"]]
8 [[
"cpp:doxygen:include:Ice/Ice.h"]]
16 [[
"objc:dll-export:ICE_API"]]
17 [[
"objc:header-dir:objc"]]
19 [[
"python:pkgdir:Ice"]]
25 #ifndef __SLICE2JAVA_COMPAT__
26 [[
"java:package:com.zeroc"]]
37 [
"cpp:scoped",
"objc:scoped"]
57 #if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
196 [
"cpp:scoped",
"objc:scoped"]
215 #if !defined(__SLICE2PHP__) && !defined(__SLICE2MATLAB__)
221 [
"swift:inherits:Swift.CustomStringConvertible"]
349 [
"swift:noexcept",
"java:optional"]
369 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept"]
string type();
378 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept"]
int timeout();
389 [
"cpp:const",
"cpp:noexcept",
"swift:noexcept"]
string toString();
430 string localAddress =
"";
436 string remoteAddress =
"";
string connectionId
The connection id.
Definition: Connection.ice:93
dictionary< string, string > HeaderDict
A collection of HTTP headers.
Definition: Connection.ice:501
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice o...
Definition: ObjectAdapter.ice:50
void setCloseCallback(CloseCallback callback)
Set a close callback on the connection.
@ Forcefully
Close the connection immediately without sending a close connection protocol message to the peer and ...
Definition: Connection.ice:203
@ Yes
Compress the batch requests.
Definition: Connection.ice:43
ObjectAdapter getAdapter()
Get the object adapter that dispatches requests for this connection.
@ HeartbeatAlways
Send a heartbeat at regular intervals until the connection is closed.
Definition: Connection.ice:177
@ HeartbeatOff
Disables heartbeats.
Definition: Connection.ice:171
@ HeartbeatOnIdle
Send a heartbeat at regular intervals when the connection is idle.
Definition: Connection.ice:175
void heartbeat()
Send a heartbeat message.
CompressBatch
The batch compression option when flushing queued batch requests.
Definition: Connection.ice:39
@ CloseOnInvocationAndIdle
Combines the behaviors of CloseOnIdle and CloseOnInvocation.
Definition: Connection.ice:157
void setBufferSize(int rcvSize, int sndSize)
Set the connection buffer receive/send size.
ConnectionInfo underlying
The information of the underyling transport or null if there's no underlying transport.
Definition: Connection.ice:71
int timeout()
Get the timeout for the connection.
ConnectionClose
Determines the behavior when manually closing a connection.
Definition: Connection.ice:198
@ Gracefully
Close the connection by notifying the peer but do not wait for pending outgoing invocations to comple...
Definition: Connection.ice:208
Object * createProxy(Identity id)
Create a special proxy that always uses this connection.
@ HeartbeatOnDispatch
Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatc...
Definition: Connection.ice:173
Provides access to the connection details of a UDP connection.
Definition: Connection.ice:470
@ GracefullyWithWait
Wait for all pending invocations to complete before closing the connection.
Definition: Connection.ice:212
Base class providing access to the connection details.
Definition: Connection.ice:64
void close(ConnectionClose mode)
Manually close the connection using the specified closure mode.
@ BasedOnProxy
Compress the batch requests if at least one request was made on a compressed proxy.
Definition: Connection.ice:54
@ CloseOff
Disables automatic connection closure.
Definition: Connection.ice:148
The user-level interface to a connection.
Definition: Connection.ice:223
void closed(Connection con)
This method is called by the the connection when the connection is closed.
void setAdapter(ObjectAdapter adapter)
Explicitly set an object adapter that dispatches requests that are received over this connection.
int timeout
A timeout value in seconds.
Definition: Connection.ice:186
ConnectionInfo getInfo()
Returns the connection information.
Provides access to the connection details of an IP connection.
Definition: Connection.ice:428
string adapterName
The name of the adapter associated with the connection.
Definition: Connection.ice:86
HeaderDict headers
The headers from the HTTP upgrade request.
Definition: Connection.ice:511
string toString()
Return a description of the connection as human readable text, suitable for logging or error messages...
An application can implement this interface to receive notifications when a connection receives a hea...
Definition: Connection.ice:131
The user-level interface to an endpoint.
Definition: Endpoint.ice:163
ACM getACM()
Get the ACM parameters.
string mcastAddress
The multicast address.
Definition: Connection.ice:476
void setHeartbeatCallback(HeartbeatCallback callback)
Set a heartbeat callback on the connection.
bool incoming
Whether or not the connection is an incoming or outgoing connection.
Definition: Connection.ice:79
ACMHeartbeat
Specifies the heartbeat semantics for Active Connection Management.
Definition: Connection.ice:169
ACMClose
Specifies the close semantics for Active Connection Management.
Definition: Connection.ice:146
The Ice core library.
Definition: BuiltinSequences.ice:27
@ No
Don't compress the batch requests.
Definition: Connection.ice:48
@ CloseOnIdle
Gracefully closes a connection that has been idle for the configured timeout period.
Definition: Connection.ice:150
@ CloseOnInvocation
Forcefully closes a connection that has been idle for the configured timeout period,...
Definition: Connection.ice:155
void throwException()
Throw an exception indicating the reason for connection closure.
Provides access to the connection details of a TCP connection.
Definition: Connection.ice:448
string type()
Return the connection type.
ACMHeartbeat heartbeat
The heartbeat semantics.
Definition: Connection.ice:190
An application can implement this interface to receive notifications when a connection closes.
Definition: Connection.ice:109
Endpoint getEndpoint()
Get the endpoint from which the connection was created.
Provides access to the connection details of a WebSocket connection.
Definition: Connection.ice:509
The identity of an Ice object.
Definition: Identity.ice:40
A collection of Active Connection Management configuration settings.
Definition: Connection.ice:184
void heartbeat(Connection con)
This method is called by the the connection when a heartbeat is received from the peer.
ACMClose close
The close semantics.
Definition: Connection.ice:188
@ CloseOnIdleForceful
Forcefully closes a connection that has been idle for the configured timeout period,...
Definition: Connection.ice:162
void flushBatchRequests(CompressBatch compress)
Flush any pending batch requests for this connection.
void setACM(optional(1) int timeout, optional(2) ACMClose close, optional(3) ACMHeartbeat heartbeat)
Set the active connection management parameters.