ice library

Classes

Application
ChildInvocationMetrics
Provides information on child invocations. A child invocation is either remote (sent over an Ice connection) or collocated. An invocation can have multiple child invocation if it is retried. Child invocation metrics are embedded within {@link InvocationMetrics}.
CloseCallback
An application can implement this interface to receive notifications when a connection closes.
CollocatedMetrics
Provides information on invocations that are collocated. Collocated metrics are embedded within {@link InvocationMetrics}.
Communicator
The central object in Ice. One or more communicators can be instantiated for an Ice application. Communicator instantiation is language-specific, and not specified in Slice code. @see Logger @see ObjectAdapter @see Properties @see ValueFactory
CommunicatorHolder
CommunicatorI
Connection
The user-level interface to a connection.
ConnectionI
ConnectionInfo
Base class providing access to the connection details.
ConnectionMetrics
Provides information on the data sent and received over Ice connections.
Current
Information about the current method invocation for servers. Each operation on the server has a Current as its implicit final parameter. Current is mostly used for Ice services. Most applications ignore this parameter.
DispatchMetrics
Provides information on servant dispatch.
Encapsulation
All the data in an encapsulation is context-free, that is, nothing inside an encapsulation can refer to anything outside the encapsulation. This feature allows encapsulations to be forwarded among address spaces as a blob of data.
EncodingVersion
A version structure for the encoding version.
Endpoint
The user-level interface to an endpoint. Combine EndpointInfo and Endpoint to Endpoint
EndpointFactory
FixedReference
Helper class, used to extract/puut header from/to a sequence of bytes.
HeartbeatCallback
An application can implement this interface to receive notifications when a connection receives a heartbeat message.
Identity
The identity of an Ice object. In a proxy, an empty Identity.name denotes a nil proxy. An identity with an empty Identity.name and a non-empty Identity.category is illegal. You cannot add a servant with an empty name to the Active Servant Map.
ImplicitContext
An interface to associate implict contexts with communicators.
Incoming
InitializationData
InputStream
Interface for input streams used to extract Slice types from a sequence of bytes.
Instance
InvocationMetrics
Provide measurements for proxy invocations. Proxy invocations can either be sent over the wire or be collocated.
IPConnectionInfo
IPEndpoint
LocalObject
TODO:
Locator
The Ice locator interface. This interface is used by clients to lookup adapters and objects. It is also used by servers to get the locator registry proxy.
LocatorFinder
This inferface should be implemented by services implementing the Ice::Locator interface. It should be advertised through an Ice object with the identity `Ice/LocatorFinder'. This allows clients to retrieve the locator proxy with just the endpoint information of the service.
LocatorRegistry
The Ice locator registry interface. This interface is used by servers to register adapter endpoints with the locator.
Logger
The Ice message logger. Applications can provide their own logger by implementing this interface and installing it in a communicator.
Message
For build and parse request/reply message Ice Protocol:
Metrics
The base class for metrics. A metrics object represents a collection of measurements associated to a given a system.
MetricsAdmin
The metrics administrative facet interface. This interface allows remote administrative clients to access metrics of an application that enabled the Ice administrative facility and configured some metrics views.
MetricsAdminI
MetricsFailures
A structure to keep track of failures associated with a given metrics.
Object
The base class for servants.
ObjectAdapter
The object adapter provides an up-call interface from the Ice run time to the implementation of Ice objects.
ObjectAdapterFactory
ObjectAdapterI
ObjectPrx
Base class of all object proxies.
Outgoing
Help create Request, send it and handle Response.
OutputStream
Interface for output streams used to create a sequence of bytes from Slice types.
Plugin
PluginManager
PluginManagerI
Process
An administrative interface for process management. Managed servers must implement this interface. A servant implementing this interface is a potential target for denial-of-service attacks, therefore proper security precautions should be taken. For example, the servant can use a UUID to make its identity harder to guess, and be registered in an object adapter with a secured endpoint.
Properties
A property set used to configure Ice and Ice applications. Properties are key/value pairs, with both keys and values being strings. By convention, property keys should have the form application-name[.category[.sub-category]].name.
PropertiesAdmin
PropertiesI
Property
ProtocolVersion
A version structure for the protocol version.
ProxyFactory
Reference
ReferenceFactory
RemoteMetrics
Provides information on invocations that are specifically sent over Ice connections. Remote metrics are embedded within {@link InvocationMetrics}.
ReplyData
Request
ResponseHandler
RoutableReference
Router
The Ice router interface. Routers can be set either globally with {@link Communicator#setDefaultRouter}, or with ice_router on specific proxies.
RouterFinder
This inferface should be implemented by services implementing the Ice::Router interface. It should be advertised through an Ice object with the identity `Ice/RouterFinder'. This allows clients to retrieve the router proxy with just the endpoint information of the service.
ServantLocator
SliceFlag
TcpConnection
TcpConnectionInfo
TcpEndpoint
ThreadMetrics
Provides information on the number of threads currently in use and their activity.
UdpConnection
UdpEndpoint
Value

Enums

CompressBatch
The batch compression option when flushing queued batch requests.
ConnectionClose
Determines the behavior when manually closing a connection.
ConnectionState
EndpointSelectionType
Determines the order in which the Ice run time uses the endpoints in a proxy when establishing a connection.
EndpointType
FormatType
MessageType
The Ice protocol message types
Mode
OperationMode
Determines the retry behavior an invocation in case of a (potentially) recoverable error.
ProtocolSupport
ReplyStatus
SliceType
State
Common state
ToStringMode
The output mode for xxxToString method such as identityToString and proxyToString. The actual encoding format for the string is the same for all modes: you don't need to specify an encoding format or mode when reading such a string.

Constants

clPropNames → const List<String>
currentEncoding → const EncodingVersion
Identifies the latest protocol encoding version.
currentProtocol → const ProtocolVersion
Identifies the latest protocol version
currentProtocolEncoding → const EncodingVersion
Identifies the latest protocol encoding version
encoding_1_0 → const EncodingVersion
encoding_1_1 → const EncodingVersion
flagHasOptionalMember → const int
flagHasSize → const int
flagHasTypeIdIndex → const int
flagHasTypeIdString → const int
Slice Class Encoding 1.1
flagIsLast → const int
FreezePropsData → const List<Property>
Glacier2CryptPermissionsVerifierPropsData → const List<Property>
Glacier2PropsData → const List<Property>
headerSize → const int
Size of the Ice protocol header
IceBoxAdminPropsData → const List<Property>
IceBoxPropsData → const List<Property>
IceBridgePropsData → const List<Property>
IceBTPropsData → const List<Property>
IceDiscoveryPropsData → const List<Property>
IceGridAdminPropsData → const List<Property>
IceGridPropsData → const List<Property>
iceIntVersion → const int
AABBCC, with AA=major, BB=minor, CC=patch
IceLocatorDiscoveryPropsData → const List<Property>
IceMXPropsData → const List<Property>
IcePatch2ClientPropsData → const List<Property>
IcePatch2PropsData → const List<Property>
IcePropsData → const List<Property>
iceSoVersion → const String
"ABC", with A=major, B=minor, C=patch
IceSSLPropsData → const List<Property>
IceStormAdminPropsData → const List<Property>
iceStringVersion → const String
"A.B.C", with A=major, B=minor, C=patch
magicLittleEndian → const int
Speed up read and write magic.
noExplicitContext → const Context
protocol_1_0 → const ProtocolVersion
validProps → const List<List<Property>>

Properties

magic Uint8List
The magic number at the front of each message
final

Functions

checkedCast<T extends ObjectPrx>(ObjectPrx o, ObjectCreator creator, [Context? context]) → T?
checkSupportedEncoding(EncodingVersion pv) → void
checkSupportedProtocol(ProtocolVersion pv) → void
createProperties([StringSeq? args, Properties? defaults]) Properties
createTcpConnect(IPEndpoint endpoint) Future<ConnectionI>
Connect to the Endpoint
createUdpConnect(UdpEndpoint endpoint) Future<ConnectionI>
endpointParser() → ArgParser
tcp -h *|{host} -p {port} -t infinite|{timeout} -z(compress) --sourceAddress {sourceAddress} udp --interface {host} --ttl {} -c(connect) -z(compress) ws -r {resource}
initialize({List<String>? args, InitializationData? initData, String? configFile, Properties? properties, int version = iceIntVersion}) Communicator
Initializes a new communicator.
parseEndpoint(Instance instance, String s) IPEndpoint?
parseReference(Instance instance, String s) RoutableReference
RoutableReference: identity -f facet -{t|o|O|d|D} -s -p {protocolVersion} -e {EncodingVersion}:tcp -h:udp: -ttl 33 identity -f facet -{t|o|O|d|D} -s -p {protocolVersion} -e {EncodingVersion} @adapterId
preferenceParser() → ArgParser
registerPluginFactory(String name, PluginFacotry factory, bool loadOnInit) → void
stringToEncodingVersion(String s) EncodingVersion
stringToIdentity(String s) Identity
stringToMajorMinor(String s) List<int>
stringToProtocolVersion(String s) ProtocolVersion
uncheckedCast<T extends ObjectPrx>(ObjectPrx o, ObjectCreator creator) → T?

Typedefs

BoolSeq = List<bool>
A sequence of bools.
ByteSeq = Uint8List
A sequence of bytes.
Context = Map<String, String>
A request context. Context is used to transmit metadata about a request from the server to the client, such as Quality-of-Service (QoS) parameters. Each operation on the client has a Context as its implicit final parameter.
DoubleSeq = List<double>
A sequence of doubles.
EndpointSeq = List<Endpoint>
FacetMap = Map<String, Object>
A mapping from facet name to servant.
FloatSeq = List<double>
A sequence of floats.
IdentitySeq = List<Identity>
IntSeq = Uint32List
A sequence of ints.
LongSeq = Uint64List
A sequence of longs.
MetricsFailuresSeq = List<MetricsFailures>
A sequence of {@link MetricsFailures}.
MetricsMap = List<Metrics>
A metrics map is a sequence of metrics. We use a sequence here instead of a map because the ID of the metrics is already included in the Metrics class and using sequences of metrics objects is more efficient than using dictionaries since lookup is not necessary.
MetricsView = Map<String, MetricsMap>
A metrics view is a dictionary of metrics map. The key of the dictionary is the name of the metrics map.
ObjectCreator = ObjectPrx Function(Reference?)
ObjectDict = Map<Identity, Object>
ObjectProxySeq = List<ObjectPrx>
A sequence of object proxies.
ObjectSeq = List<Object>
A sequence of objects.
PluginFacotry = Plugin Function(Communicator communicator, String name, List<String> args)
PropertyDict = Map<String, String>
ReplyHandle = dynamic Function(ReplyStatus status, InputStream input)
ShortSeq = Uint16List
A sequence of shorts.
StringIntDict = Map<String, int>
StringSeq = List<String>
A sequence of strings.
WriteParams = void Function(OutputStream output)

Exceptions / Errors

AdapterAlreadyActiveException
This exception is raised if a server tries to set endpoints for an adapter that is already active.
AdapterNotFoundException
This exception is raised if an adapter cannot be found.
AlreadyRegisteredException
BadMagicException
CFNetworkException
CloneNotImplementedException
CloseConnectionException
CloseTimeoutException
CollocationOptimizationException
CommunicatorDestroyedException
CompressionException
ConnectFailedException
ConnectionLostException
ConnectionManuallyClosedException
ConnectionNotValidatedException
ConnectionRefusedException
ConnectionTimeoutException
ConnectTimeoutException
DatagramLimitException
DNSException
EncapsulationException
EndpointParseException
EndpointSelectionTypeParseException
FacetNotExistException
FeatureNotSupportedException
FileException
FixedProxyException
IdentityParseException
IllegalIdentityException
IllegalMessageSizeException
IllegalServantException
InitializationException
InvalidReplicaGroupIdException
This exception is raised if the replica group provided by the server is invalid.
InvocationCanceledException
InvocationTimeoutException
MarshalException
MemoryLimitException
NoEndpointException
NotRegisteredException
NoValueFactoryException
ObjectAdapterDeactivatedException
ObjectAdapterIdInUseException
ObjectNotExistException
ObjectNotFoundException
This exception is raised if an object cannot be found.
OperationInterruptedException
OperationNotExistException
PluginInitializationException
ProtocolException
ProxyParseException
ProxyUnmarshalException
RequestFailedException
ResponseSentException
SecurityException
ServerNotFoundException
This exception is raised if a server cannot be found.
SocketException
StringConversionException
SyscallException
TimeoutException
TwowayOnlyException
UnexpectedObjectException
UnknownException
UnknownLocalException
UnknownMessageException
UnknownMetricsView
Raised if a metrics view cannot be found.
UnknownReplyStatusException
UnknownRequestIdException
UnknownUserException
UnmarshalOutOfBoundsException
UnsupportedEncodingException
UnsupportedProtocolException
VersionMismatchException
VersionParseException