Terminology
6 min read
6 min read
6 min read
6 min read
6 min read
6 min read
6 min read
6 min read
6 min read
Ice uses the terminology of other RPC frameworks where it can. This page defines the terms the rest of the manual uses, and links to the pages that describe each concept.
Clients and Servers
Client and server are roles that applications take for the duration of a request: the client issues the request, and the server processes it. An application can take both roles. For example, an application that passes a proxy for one of its objects in a request is the client of this request, and the server when another application invokes this object through the proxy.
These roles do not depend on which side opened the connection: over a bidirectional connection, either side can issue requests. See Ice Protocol for the names of the two sides of a connection.
Ice Objects
An Ice object is an entity, in the local process or in a remote process, that responds to client requests. Each Ice object has a unique object identity and a type, a Slice interface that defines the operations clients invoke. Besides its main interface, an Ice object can provide alternate interfaces, known as facets.
Proxies
A proxy is the client's representative of an Ice object: a local value that holds the object's identity, an optional facet name, and the information the Ice runtime needs to reach the object. A client invokes operations on an Ice object through a proxy. A direct proxy holds the endpoints of the object; an indirect proxy holds an adapter ID or only the identity, which the Ice runtime resolves into endpoints with a locator.
Invocation and Dispatch
An invocation is a call to an operation on an Ice object through a proxy. A dispatch is the server-side processing of a request.
Stringified Proxies
A stringified proxy is the string form of a proxy, such as SimplePrinter:tcp -p 10000. See Syntax for Stringified Proxies.
Endpoints
An endpoint is a transport and its parameters, such as tcp -h server1 -p 10000: the address at which an object adapter listens for connections, and the address a proxy holds to reach it. See Proxy Endpoints and Endpoint Syntax.
Communicators
A communicator is the main entry point to the Ice runtime. It holds the configuration properties, opens and caches the outgoing connections that proxies use, and creates object adapters.
Connections
A connection links two peers over a transport. See Connection Management.
Transports
A transport, such as tcp, ssl, ws, wss or udp, carries the messages of the Ice protocol between two peers.
Object Adapters
An object adapter dispatches the requests it receives to the servants you register with it. A communicator can create several object adapters, each with its own configuration.
Dispatcher
A dispatcher is the programming language abstraction for a dispatch: it accepts a request and returns the corresponding response.
Servants
A servant is an instance of a class that you write in your server to implement one or more Ice objects; the servant is said to incarnate these objects. Most servants implement a skeleton generated by the Slice compiler, with one method per operation; a servant can also implement the dispatcher abstraction directly. See The Active Servant Map and Default Servants.
Middleware
A middleware is a dispatcher that intercepts a request before it reaches the servant, and the response before the object adapter sends it back. It can also return a response without passing the request on.
Locators
A locator is an Ice object that implements the Ice::Locator interface: the Ice runtime asks it to resolve the adapter ID or the identity of an indirect proxy into endpoints. The IceGrid registry is a locator. A locator lets a server move to another address without invalidating the indirect proxies that clients hold.
Routers
A router forwards the invocations of the proxies configured with it to their target objects. Glacier2 is such a router.
Asynchronous Method Invocation
With asynchronous method invocation (AMI), the calling thread does not wait for the invocation to complete: depending on the language mapping, the invocation returns a future or an awaitable, or calls a callback when it completes. See Operations.
Synchronous Method Invocation
With synchronous method invocation (SMI), the calling thread waits until the invocation completes. In languages with async/await support, use AMI even when the mapping also provides SMI.
A server cannot tell whether a client invoked an operation synchronously or asynchronously.
Asynchronous Method Dispatch
With asynchronous method dispatch (AMD), the implementation of an operation frees the dispatch thread while it waits, for example at an await, and completes the dispatch later. See Operations.
Synchronous Method Dispatch
With synchronous method dispatch (SMD), the dispatch thread stays busy until the implementation of the operation returns.
A client cannot tell whether the server dispatched a request synchronously or asynchronously.
Properties
Much of the Ice runtime is configurable via properties. Properties are name-value pairs, such as Ice.Default.Protocol=tcp. Properties are typically stored in text files and parsed by the Ice runtime to configure various options, such as the thread pool size, the level of tracing, and various other configuration parameters.