Ice Namespace Reference

The Ice RPC framework. More...

Namespaces
namespace	Instrumentation
	Observers for objects created by the Ice runtime.
namespace	SSL
	Secure connections with SSL/TLS.
namespace	Tuple
	Relational operators for generated structs.

Classes
class	AdapterAlreadyActiveException
	The exception that is thrown when a server application tries to register endpoints for an object adapter that is already active. More...
class	AdapterNotFoundException
	The exception that is thrown by a LocatorPrx implementation when it cannot find an object adapter with the provided adapter ID. More...
class	AlreadyRegisteredException
	The exception that is thrown when you attempt to register an object more than once with the Ice runtime. More...
class	BasicStringConverter
	A StringConverter converts narrow or wide-strings to and from UTF-8 byte sequences. More...
class	BatchRequest
	Represents a batch request. More...
class	Blobject
	Base class for dynamic dispatch servants. More...
class	BlobjectArray
	Base class for dynamic dispatch servants that uses the array mapping. More...
class	BlobjectArrayAsync
	Base class for asynchronous dynamic dispatch servants that uses the array mapping. More...
class	BlobjectAsync
	Base class for asynchronous dynamic dispatch servants. More...
class	CloseConnectionException
	The exception that is thrown when the connection has been gracefully shut down by the server. More...
class	CloseTimeoutException
	The exception that is thrown when a graceful connection closure times out. More...
class	Communicator
	Communicator is the central object in Ice. More...
class	CommunicatorDestroyedException
	The exception that is thrown when an operation fails because the communicator has been destroyed. More...
class	CommunicatorHolder
	A helper class that uses Resource Acquisition Is Initialization (RAII) to hold a communicator instance, and automatically destroy this instance when the holder goes out of scope. More...
class	CompositeSliceLoader
	Implements SliceLoader by combining multiple SliceLoader instances. More...
class	ConnectFailedException
	The exception that is thrown when a connection establishment fails. More...
class	Connection
	Represents a connection that uses the Ice protocol. More...
class	ConnectionAbortedException
	The exception that is thrown when an operation fails because the connection has been aborted. More...
class	ConnectionClosedException
	The exception that is thrown when an operation fails because the connection has been closed gracefully. More...
class	ConnectionInfo
	Base class for all connection info classes. More...
class	ConnectionLostException
	The exception that is thrown when an established connection is lost. More...
class	ConnectionRefusedException
	The exception that is thrown when the server host actively refuses a connection. More...
class	ConnectTimeoutException
	The exception that is thrown when a connection establishment times out. More...
class	CtrlCHandler
	Provides a portable way to handle Ctrl+C and Ctrl+C like signals. More...
struct	Current
	Provides information about an incoming request being dispatched. More...
class	DatagramLimitException
	The exception that is thrown when a datagram exceeds the configured send or receive buffer size, or exceeds the maximum payload size of a UDP packet (65507 bytes). More...
class	DispatchException
	The exception that is thrown when a dispatch failed. More...
class	DNSException
	The exception that is thrown to report a DNS resolution failure. More...
struct	EncodingVersion
	Represents a version of the Slice encoding. More...
class	Endpoint
	An endpoint specifies the address of the server-end of an Ice connection: an object adapter listens on one or more endpoints and a client establishes a connection to an endpoint. More...
class	EndpointInfo
	Base class for the endpoint info classes. More...
class	Exception
	Abstract base class for all Ice exceptions. More...
class	FacetNotExistException
	The exception that is thrown when a dispatch cannot find a servant for the identity + facet carried by the request. More...
class	FeatureNotSupportedException
	The exception that is thrown when attempting to use an unsupported feature. More...
class	FileException
	The exception that is thrown to report a file system error. More...
class	FixedProxyException
	The exception that is thrown when attempting to change a connection-related property on a fixed proxy. More...
class	IAPConnectionInfo
	Provides access to the connection details of an IAP connection. More...
class	IAPEndpointInfo
	Provides access to an IAP endpoint information. More...
struct	Identity
	Represents the identity of an Ice object. More...
class	IllegalConversionException
	This exception indicates the failure of a string conversion. More...
class	ImplicitContext
	Represents the request context associated with a communicator. More...
class	IncomingRequest
	Represents a request received by a connection. More...
struct	InitializationData
	Represents a set of options that you can specify when initializing a communicator. More...
class	InitializationException
	The exception that is thrown when communicator initialization fails. More...
class	InputStream
	Represents a byte buffer used for unmarshaling data encoded using the Slice encoding. More...
class	InvalidReplicaGroupIdException
	The exception that is thrown when the provided replica group is invalid. More...
class	InvocationCanceledException
	The exception that is thrown when an asynchronous invocation fails because it was canceled explicitly by the user. More...
class	InvocationTimeoutException
	The exception that is thrown when an invocation times out. More...
class	IPConnectionInfo
	Provides access to the connection details of an IP connection. More...
class	IPEndpointInfo
	Provides access to the address details of an IP endpoint. More...
class	LocalException
	Base class for all Ice exceptions not defined in Slice. More...
class	Locator
	Client applications use the Locator object to resolve Ice indirect proxies. More...
class	LocatorFinder
	Provides access to a LocatorPrx object via a fixed identity. More...
class	LocatorFinderPrx
	Provides access to a LocatorPrx object via a fixed identity. More...
class	LocatorPrx
	Client applications use the Locator object to resolve Ice indirect proxies. More...
class	LocatorRegistry
	A server application registers the endpoints of its indirect object adapters with the LocatorRegistry object. More...
class	LocatorRegistryPrx
	A server application registers the endpoints of its indirect object adapters with the LocatorRegistry object. More...
class	Logger
	Represents Ice's abstraction for logging and tracing. More...
class	LoggerAdmin
	Represents the admin facet that allows an Ice application to attach its RemoteLoggerPrx to the local logger of an Ice communicator.
class	LoggerAdminPrx
	Represents the admin facet that allows an Ice application to attach its RemoteLoggerPrx to the local logger of an Ice communicator. More...
class	LoggerOutput
	Collects output and flushes it via a logger method. More...
class	LoggerOutputBase
	Base class for logger output utility classes. More...
class	LoggerPlugin
	A special plug-in that installs a logger during a communicator's initialization. More...
struct	LogMessage
	Represents a full log message. More...
class	MarshaledResult
	Base class for marshaled result structures, which are generated for operations having the marshaled-result metadata tag. More...
class	MarshalException
	The exception that is thrown when an error occurs during marshaling or unmarshaling. More...
class	NativePropertiesAdmin
	The default implementation for the "Properties" admin facet. More...
class	NoEndpointException
	The exception that is thrown when the Ice runtime cannot find a suitable endpoint to connect to. More...
class	NotRegisteredException
	An attempt was made to find or deregister something that is not registered with Ice. More...
class	Object
	The base class for servants. More...
class	ObjectAdapter
	An object adapter is the main server-side Ice API. More...
class	ObjectAdapterDeactivatedException
	The exception that is thrown when attempting to use an ObjectAdapter that has been deactivated. More...
class	ObjectAdapterDestroyedException
	The exception that is thrown when attempting to use an ObjectAdapter that has been destroyed. More...
class	ObjectAdapterIdInUseException
	The exception that is thrown when an ObjectAdapter cannot be activated. More...
class	ObjectNotExistException
	The exception that is thrown when a dispatch cannot find a servant for the identity carried by the request. More...
class	ObjectNotFoundException
	The exception that is thrown by a LocatorPrx implementation when it cannot find an object with the provided identity. More...
class	ObjectPrx
	The base class for all Ice proxies. More...
class	OpaqueEndpointInfo
	Provides access to the details of an opaque endpoint. More...
class	OperationNotExistException
	The exception that is thrown when a dispatch cannot find the operation carried by the request on the target servant. More...
class	OutgoingResponse
	Represents the response to an incoming request. More...
class	OutputStream
	Represents a byte buffer used for marshaling data using the Slice encoding. More...
class	ParseException
	The exception that is thrown when the parsing of a string fails. More...
class	Plugin
	Represents a communicator plug-in. More...
struct	PluginFactory
	Represents a plug-in factory. More...
class	PluginInitializationException
	The exception that is thrown when the initialization of an Ice plugin fails. More...
class	PluginManager
	Manages the plug-ins of a communicator. More...
class	Process
	A server application managed by a locator implementation such as IceGrid hosts a Process object and registers a proxy to this object with the locator registry.
class	ProcessPrx
	A server application managed by a locator implementation such as IceGrid hosts a Process object and registers a proxy to this object with the locator registry. More...
class	Properties
	Represents a set of properties used to configure Ice and Ice-based applications. More...
class	PropertiesAdmin
	Provides remote access to the properties of a communicator. More...
class	PropertiesAdminPrx
	Provides remote access to the properties of a communicator. More...
class	PropertyException
	The exception that is thrown when a property cannot be set or retrieved. More...
class	ProtocolException
	The base class for exceptions related to the Ice protocol. More...
struct	ProtocolVersion
	Represents a version of the Ice protocol. More...
class	Proxy
	Provides typed proxy functions. More...
class	RemoteLogger
	Represents an Ice object that accepts log messages. More...
class	RemoteLoggerAlreadyAttachedException
	Thrown when the provided RemoteLoggerPrx was previously attached to a LoggerAdminPrx. More...
class	RemoteLoggerPrx
	Represents an Ice object that accepts log messages. More...
class	RequestFailedException
	The base class for the 3 NotExist exceptions. More...
class	Router
	Represents an intermediary object that routes requests and replies between clients and Ice objects that are not directly reachable from these clients. More...
class	RouterFinder
	Provides access to a RouterPrx object via a fixed identity. More...
class	RouterFinderPrx
	Provides access to a RouterPrx object via a fixed identity. More...
class	RouterPrx
	Represents an intermediary object that routes requests and replies between clients and Ice objects that are not directly reachable from these clients. More...
class	SecurityException
	The exception that is thrown when a failure occurs in the security subsystem. More...
class	ServantLocator
	An application-provided class that an object adapter uses to locate servants. More...
class	ServerNotFoundException
	The exception that is thrown when a server was not found. More...
class	Service
	A singleton class that helps you write Windows services and Unix daemons using Ice. More...
class	SlicedData
	Holds class slices that cannot be unmarshaled because their types are not known locally. More...
struct	SliceInfo
	Encapsulates the details of a class slice with an unknown type. More...
class	SliceLoader
	Creates class and exception instances from Slice type IDs. More...
class	SocketException
	The exception that is thrown to report a socket error. More...
struct	StreamableTraits
	Provides traits for a type that can be marshaled or unmarshaled to/from a stream of bytes using the Slice encoding. More...
struct	StreamHelper
	A helper template class for writing (marshaling) and reading (unmarshaling) values to and from a stream of Slice-encoded bytes. More...
class	SyscallException
	The exception that is thrown to report the failure of a system call. More...
class	TCPConnectionInfo
	Provides access to the connection details of a TCP connection. More...
class	TCPEndpointInfo
	Provides access to a TCP endpoint information. More...
class	TimeoutException
	The exception that is thrown when a timeout occurs. More...
class	Trace
	Flushes output to Logger::trace. More...
class	TwowayOnlyException
	The exception that is thrown when attempting to invoke an operation with ice_oneway, ice_batchOneway, ice_datagram, or ice_batchDatagram, and the operation has a return value, an out parameter, or an exception specification. More...
class	UDPConnectionInfo
	Provides access to the connection details of a UDP connection. More...
class	UDPEndpointInfo
	Provides access to an UDP endpoint information. More...
class	UnknownException
	The exception that is thrown when a dispatch failed with an exception that is not a LocalException or a UserException. More...
class	UnknownLocalException
	The exception that is thrown when a dispatch failed with a LocalException that is not a DispatchException. More...
class	UnknownSlicedValue
	Represents an instance of an unknown class. More...
class	UnknownUserException
	The exception that is thrown when a client receives a UserException that was not declared in the operation's exception specification. More...
class	UserException
	Abstract base class for all Ice exceptions defined in Slice. More...
class	UTF8Buffer
	Provides bytes to toUTF8. More...
class	Value
	The base class for instances of Slice-defined classes. More...
class	WSConnectionInfo
	Provides access to the connection details of a WebSocket connection. More...
class	WSEndpointInfo
	Provides access to a WebSocket endpoint information. More...

Typedefs
using	BoolSeq = std::vector<bool>
	A sequence of bools.
using	ByteSeq = std::vector<std::byte>
	A sequence of bytes.
using	CloseCallback = std::function<void(const ConnectionPtr& con)>
	The callback function given to Connection::setCloseCallback.
using	CommunicatorPtr = std::shared_ptr<Communicator>
	A shared pointer to a Communicator.
using	CompositeSliceLoaderPtr = std::shared_ptr<CompositeSliceLoader>
	A shared pointer to a CompositeSliceLoaderPtr.
using	ConnectionInfoPtr = std::shared_ptr<ConnectionInfo>
	A shared pointer to a ConnectionInfo.
using	ConnectionPtr = std::shared_ptr<Connection>
	A shared pointer to a Connection.
using	Context = std::map<std::string, std::string, std::less<>>
	Represents additional information carried by an Ice request.
using	CtrlCHandlerCallback = std::function<void(int sig)>
	The function called by CtrlCHandler when it catches a signal.
using	DoubleSeq = std::vector<double>
	A sequence of doubles.
using	EndpointInfoPtr = std::shared_ptr<EndpointInfo>
	A shared pointer to an EndpointInfo.
using	EndpointPtr = std::shared_ptr<Endpoint>
	A shared pointer to an Endpoint.
using	EndpointSeq = std::vector<EndpointPtr>
	A sequence of endpoints.
using	Error = LoggerOutput<Logger, LoggerPtr, &Logger::error>
	Flushes output to Logger::error.
using	FacetMap = std::map<std::string, ObjectPtr, std::less<>>
	A mapping from facet name to servant.
using	FloatSeq = std::vector<float>
	A sequence of floats.
using	HeaderDict = std::map<std::string, std::string, std::less<>>
	Represents a collection of HTTP headers.
using	IdentitySeq = std::vector<Identity>
	A sequence of identities.
using	ImplicitContextPtr = std::shared_ptr<ImplicitContext>
	A shared pointer to an ImplicitContext.
using	IntSeq = std::vector<std::int32_t>
	A sequence of ints.
using	IPConnectionInfoPtr = std::shared_ptr<IPConnectionInfo>
	A shared pointer to an IPConnectionInfo.
using	IPEndpointInfoPtr = std::shared_ptr<IPEndpointInfo>
	A shared pointer to an IPEndpointInfo.
using	LocatorFinderPtr = std::shared_ptr<LocatorFinder>
	A shared pointer to a LocatorFinder.
using	LocatorPtr = std::shared_ptr<Locator>
	A shared pointer to a Locator.
using	LocatorRegistryPtr = std::shared_ptr<LocatorRegistry>
	A shared pointer to a LocatorRegistry.
using	LoggerAdminPtr = std::shared_ptr<LoggerAdmin>
	A shared pointer to a LoggerAdmin.
using	LoggerPtr = std::shared_ptr<Logger>
	A shared pointer to a Logger.
using	LogMessageSeq = std::list<LogMessage>
	A sequence of LogMessage.
using	LogMessageTypeSeq = std::vector<LogMessageType>
	A sequence of LogMessageType.
using	LongSeq = std::vector<std::int64_t>
	A sequence of longs.
using	NativePropertiesAdminPtr = std::shared_ptr<NativePropertiesAdmin>
	A shared pointer to a NativePropertiesAdmin.
using	ObjectAdapterPtr = std::shared_ptr<ObjectAdapter>
	A shared pointer to an ObjectAdapter.
using	ObjectProxySeq = std::vector<std::optional<Ice::ObjectPrx>>
	A sequence of object proxies.
using	ObjectPtr = std::shared_ptr<Object>
	A shared pointer to an Object.
using	OpaqueEndpointInfoPtr = std::shared_ptr<OpaqueEndpointInfo>
	A shared pointer to an OpaqueEndpointInfo.
using	PluginFactoryFunc
	A plug-in factory function responsible for creating an Ice plug-in.
using	PluginManagerPtr = std::shared_ptr<PluginManager>
	A shared pointer to a PluginManager.
using	PluginPtr = std::shared_ptr<Plugin>
	A shared pointer to a Plugin.
using	Print = LoggerOutput<Logger, LoggerPtr, &Logger::print>
	Flushes output to Logger::print.
using	ProcessPtr = std::shared_ptr<Process>
	A shared pointer to a Process.
using	PropertiesAdminPtr = std::shared_ptr<PropertiesAdmin>
	A shared pointer to a PropertiesAdmin.
using	PropertiesPtr = std::shared_ptr<Properties>
	A shared pointer to a Properties.
using	PropertyDict = std::map<std::string, std::string, std::less<>>
	A simple collection of properties, represented as a dictionary of key/value pairs.
using	RemoteLoggerPtr = std::shared_ptr<RemoteLogger>
	A shared pointer to a RemoteLogger.
using	RouterFinderPtr = std::shared_ptr<RouterFinder>
	A shared pointer to a RouterFinder.
using	RouterPtr = std::shared_ptr<Router>
	A shared pointer to a Router.
using	ServantLocatorPtr = std::shared_ptr<ServantLocator>
	A shared pointer to a ServantLocator.
using	ShortSeq = std::vector<std::int16_t>
	A sequence of shorts.
using	SlicedDataPtr = std::shared_ptr<SlicedData>
	A shared pointer to a SlicedData.
using	SliceInfoPtr = std::shared_ptr<SliceInfo>
	A shared pointer to a SliceInfo.
using	SliceInfoSeq = std::vector<SliceInfoPtr>
	The slices of unknown types.
using	SliceLoaderPtr = std::shared_ptr<SliceLoader>
	A shared pointer to a SliceLoader.
using	StreamHelperCategory = int
	The stream helper category allows to select a StreamHelper specialization for a specific category of types.
using	StringConverter = BasicStringConverter<char>
	A narrow string converter.
using	StringConverterPtr = std::shared_ptr<StringConverter>
	A shared pointer to a StringConverter.
using	StringSeq = std::vector<std::string>
	A sequence of strings.
using	TCPConnectionInfoPtr = std::shared_ptr<TCPConnectionInfo>
	A shared pointer to a TCPConnectionInfo.
using	TCPEndpointInfoPtr = std::shared_ptr<TCPEndpointInfo>
	A shared pointer to a TCPEndpointInfo.
using	UDPConnectionInfoPtr = std::shared_ptr<UDPConnectionInfo>
	A shared pointer to a UDPConnectionInfo.
using	UDPEndpointInfoPtr = std::shared_ptr<UDPEndpointInfo>
	A shared pointer to a UDPEndpointInfo.
using	UnknownSlicedValuePtr = std::shared_ptr<UnknownSlicedValue>
	A shared pointer to an UnknownSlicedValue.
using	UserExceptionFactory = std::function<void(std::string_view)>
	Creates and throws a user exception.
using	ValuePtr
	A shared pointer to a Value.
using	ValuePtr = std::shared_ptr<Value>
	A shared pointer to a Value.
using	Warning = LoggerOutput<Logger, LoggerPtr, &Logger::warning>
	Flushes output to Logger::warning.
using	WSConnectionInfoPtr = std::shared_ptr<WSConnectionInfo>
	A shared pointer to a WSConnectionInfo.
using	WSEndpointInfoPtr = std::shared_ptr<WSEndpointInfo>
	A shared pointer to a WSEndpointInfo.
using	WstringConverter = BasicStringConverter<wchar_t>
	A wide string converter.
using	WstringConverterPtr = std::shared_ptr<WstringConverter>
	A shared pointer to a WstringConverter.

Enumerations
enum class	CompressBatch : std::uint8_t { Yes , No , BasedOnProxy }
	Represents batch compression options when flushing queued batch requests. More...
enum class	EndpointSelectionType : std::uint8_t { Random , Ordered }
	Determines how the Ice runtime sorts proxy endpoints when establishing a connection. More...
enum class	FormatType : std::uint8_t { CompactFormat , SlicedFormat }
	Specifies the format for marshaling classes and exceptions with the Slice 1.1 encoding. More...
enum class	LogMessageType : std::uint8_t { PrintMessage , TraceMessage , WarningMessage , ErrorMessage }
	Represents the different types of log messages. More...
enum class	OperationMode : std::uint8_t { Normal , Nonmutating , Idempotent }
	Specifies if an operation is idempotent, which affects the retry behavior of the Ice client runtime. More...
enum class	OptionalFormat : std::uint8_t {   F1 = 0 , F2 = 1 , F4 = 2 , F8 = 3 ,   Size = 4 , VSize = 5 , FSize = 6 , Class = 7 }
	The optional format, used for marshaling optional fields and arguments. More...
enum class	ReplyStatus : std::uint8_t {   Ok = 0 , UserException = 1 , ObjectNotExist = 2 , FacetNotExist = 3 ,   OperationNotExist = 4 , UnknownLocalException = 5 , UnknownUserException = 6 , UnknownException = 7 ,   InvalidData = 8 , Unauthorized = 9 }
	Represents the status of a reply. More...
enum class	ToStringMode : std::uint8_t { Unicode , ASCII , Compat }
	The output mode for xxxToString methods such as identityToString and proxyToString. More...

Functions
StringSeq	argsToStringSeq (int argc, const char *const argv[])
	Converts an argument vector into a string sequence.
StringSeq	argsToStringSeq (int argc, const wchar_t *const argv[])
	Converts an argument vector into a string sequence.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::optional< Prx >	checkedCast (const ObjectPrx &proxy, const Context &context=noExplicitContext)
	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::optional< Prx >	checkedCast (const ObjectPrx &proxy, std::string facet, const Context &context=noExplicitContext)
	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::optional< Prx >	checkedCast (const std::optional< ObjectPrx > &proxy, const Context &context=noExplicitContext)
	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::optional< Prx >	checkedCast (const std::optional< ObjectPrx > &proxy, std::string facet, const Context &context=noExplicitContext)
	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
ICE_API void	checkNonIdempotent (const Current &current)
	Makes sure the operation mode of an incoming request is not idempotent.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
void	checkNotNull (const std::optional< Prx > &prx, const char *file, int line, const Current &current)
	Verifies that a proxy received from the client is not null, and throws a MarshalException if it is.
template<typename charT>
std::shared_ptr< Ice::BasicStringConverter< charT > >	createIconvStringConverter (const std::string &internalCodeWithDefault="")
	Creates a string converter for the given code.
PropertiesPtr	createProperties ()
	Creates an empty property set.
PropertiesPtr	createProperties (int &argc, char *argv[], const PropertiesPtr &defaults=nullptr)
	Creates a property set initialized from command-line arguments and a default property set.
PropertiesPtr	createProperties (int &argc, const char *argv[], const PropertiesPtr &defaults=nullptr)
	Creates a property set initialized from command-line arguments and a default property set.
PropertiesPtr	createProperties (int &argc, const wchar_t *argv[], const PropertiesPtr &defaults=nullptr)
	Creates a property set initialized from command-line arguments and a default property set.
PropertiesPtr	createProperties (int &argc, wchar_t *argv[], const PropertiesPtr &defaults=nullptr)
	Creates a property set initialized from command-line arguments and a default property set.
PropertiesPtr	createProperties (StringSeq &seq, const PropertiesPtr &defaults=nullptr)
	Creates a property set initialized from command-line arguments and a default property set.
WstringConverterPtr	createUnicodeWstringConverter ()
	Creates a WstringConverter that converts to and from UTF-16 or UTF-32 depending on sizeof(wchar_t).
StringConverterPtr	createWindowsStringConverter (unsigned int page)
	Creates a StringConverter that converts to and from narrow chars in the given code page, using MultiByteToWideChar and WideCharToMultiByte.
std::string	encodingVersionToString (const EncodingVersion &v)
	Converts an encoding version into a string.
std::string	generateUUID ()
	Generates a universally unique identifier (UUID).
LoggerPtr	getProcessLogger ()
	Gets the per-process logger.
StringConverterPtr	getProcessStringConverter ()
	Retrieves the per-process narrow string converter.
WstringConverterPtr	getProcessWstringConverter ()
	Retrieves the per-process wide string converter.
PluginFactory	iapPluginFactory ()
	Returns the factory for the iAP transport plug-in, IceIAP.
std::string	identityToString (const Identity &id, ToStringMode mode=ToStringMode::Unicode)
	Converts an Identity into a string using the specified mode.
CommunicatorPtr	initialize (InitializationData initData={})
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, char *argv[], InitializationData initData={})
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, char *argv[], std::string_view configFile)
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, const char *argv[], InitializationData initData={})
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, const char *argv[], std::string_view configFile)
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, const wchar_t *argv[], InitializationData initData={})
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, const wchar_t *argv[], std::string_view configFile)
CommunicatorPtr	initialize (int &argc, wchar_t *argv[], InitializationData initData={})
	Creates a new communicator.
CommunicatorPtr	initialize (int &argc, wchar_t *argv[], std::string_view configFile)
CommunicatorPtr	initialize (std::string_view configFile)
	Creates a new communicator.
CommunicatorPtr	initialize (StringSeq &seq, InitializationData initData={})
	Creates a new communicator.
CommunicatorPtr	initialize (StringSeq &seq, std::string_view configFile)
	Creates a new communicator.
OutgoingResponse	makeEmptyOutgoingResponse (const Current &current) noexcept
	Creates an OutgoingResponse object with ReplyStatus::Ok and an empty payload.
OutgoingResponse	makeOutgoingResponse (bool ok, std::pair< const std::byte *, const std::byte * > encapsulation, const Current &current) noexcept
	Creates an OutgoingResponse object with ReplyStatus::Ok or ReplyStatus::UserException.
OutgoingResponse	makeOutgoingResponse (const std::function< void(OutputStream *)> &marshal, const Current &current, std::optional< FormatType > format=std::nullopt) noexcept
	Creates an OutgoingResponse object with ReplyStatus::Ok.
OutgoingResponse	makeOutgoingResponse (std::exception_ptr exception, const Current &current) noexcept
	Creates an OutgoingResponse object with a reply status other than ReplyStatus::Ok.
std::string	nativeToUTF8 (std::string_view str, const StringConverterPtr &nc)
	Converts the given string from the native narrow string encoding to UTF-8 using the given converter.
bool	operator!= (const ObjectPrx &lhs, const ObjectPrx &rhs) noexcept
	Operator not equal to.
bool	operator< (const ObjectPrx &lhs, const ObjectPrx &rhs) noexcept
	Operator less-than.
std::ostream &	operator<< (std::ostream &os, const EncodingVersion &value)
	Outputs the description of an EncodingVersion to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const Exception &exception)
	Outputs a description of an Ice exception to a stream by calling Exception::ice_print on this exception.
std::ostream &	operator<< (std::ostream &os, const Identity &value)
	Outputs the description of an Identity to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const LogMessage &value)
	Outputs the description of a LogMessage to a stream, including all its fields.
std::ostream &	operator<< (std::ostream &os, const ObjectPrx &proxy)
	Outputs the stringified version of a proxy to a stream.
std::ostream &	operator<< (std::ostream &os, const ProtocolVersion &value)
	Outputs the description of a ProtocolVersion to a stream, including all its fields.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::ostream &	operator<< (std::ostream &os, const std::optional< Prx > &proxy)
	Outputs the stringified version of a proxy to a stream.
template<class T, std::enable_if_t< std::is_base_of_v< Value, T >, bool > = true>
std::ostream &	operator<< (std::ostream &os, const std::shared_ptr< T > &value)
	Outputs the description of a class instance held in a shared_ptr.
std::ostream &	operator<< (std::ostream &os, const Value &value)
	Outputs the description of a class instance to a stream.
std::ostream &	operator<< (std::ostream &os, LogMessageType value)
	Outputs the enumerator name or underlying value of a LogMessageType to a stream.
std::ostream &	operator<< (std::ostream &os, OperationMode value)
	Outputs the enumerator name or underlying value of an OperationMode to a stream.
std::ostream &	operator<< (std::ostream &os, ReplyStatus value)
	Outputs the enumerator name or underlying value of a ReplyStatus to a stream.
bool	operator<= (const ObjectPrx &lhs, const ObjectPrx &rhs) noexcept
	Operator less-than or equal to.
bool	operator== (const ObjectPrx &lhs, const ObjectPrx &rhs) noexcept
	Operator equal to.
bool	operator> (const ObjectPrx &lhs, const ObjectPrx &rhs) noexcept
	Operator greater-than.
bool	operator>= (const ObjectPrx &lhs, const ObjectPrx &rhs) noexcept
	Operator greater-than or equal to.
template<typename T>
void	print (std::ostream &stream, T v)
	Prints a value to a stream.
std::string	protocolVersionToString (const ProtocolVersion &v)
	Converts a protocol version into a string.
bool	proxyIdentityAndFacetEqual (const std::optional< ObjectPrx > &lhs, const std::optional< ObjectPrx > &rhs) noexcept
	Compares the object identities and facets of two proxies.
bool	proxyIdentityAndFacetLess (const std::optional< ObjectPrx > &lhs, const std::optional< ObjectPrx > &rhs) noexcept
	Compares the object identities and facets of two proxies.
bool	proxyIdentityEqual (const std::optional< ObjectPrx > &lhs, const std::optional< ObjectPrx > &rhs) noexcept
	Compares the object identities of two proxies.
bool	proxyIdentityLess (const std::optional< ObjectPrx > &lhs, const std::optional< ObjectPrx > &rhs) noexcept
	Compares the object identities of two proxies.
void	setProcessLogger (const LoggerPtr &logger)
	Sets the per-process logger.
void	setProcessStringConverter (const StringConverterPtr &c)
	Sets the per-process narrow string converter.
void	setProcessWstringConverter (const WstringConverterPtr &c)
	Sets the per process wide string converter.
void	stringSeqToArgs (const StringSeq &seq, int &argc, char *argv[])
	Updates argv to match the contents of seq.
void	stringSeqToArgs (const StringSeq &seq, int &argc, const char *argv[])
	Updates argv to match the contents of seq.
void	stringSeqToArgs (const StringSeq &seq, int &argc, const wchar_t *argv[])
	Updates argv to match the contents of seq.
void	stringSeqToArgs (const StringSeq &seq, int &argc, wchar_t *argv[])
	Updates argv to match the contents of seq.
EncodingVersion	stringToEncodingVersion (std::string_view v)
	Converts a string into an encoding version.
Identity	stringToIdentity (std::string_view str)
	Converts a stringified identity into an Identity.
ProtocolVersion	stringToProtocolVersion (std::string_view v)
	Converts a string into a protocol version.
std::wstring	stringToWstring (const std::string &str, const StringConverterPtr &nc=nullptr, const WstringConverterPtr &wc=nullptr)
	Converts the given narrow string to a wide string.
PluginFactory	udpPluginFactory ()
	Returns the factory for the UDP transport plug-in, IceUDP.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
Prx	uncheckedCast (const ObjectPrx &proxy)
	Creates a new proxy from an existing proxy.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
Prx	uncheckedCast (const ObjectPrx &proxy, std::string facet)
	Creates a new proxy from an existing proxy.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::optional< Prx >	uncheckedCast (const std::optional< ObjectPrx > &proxy)
	Creates a new proxy from an existing proxy.
template<typename Prx, std::enable_if_t< std::is_base_of_v< ObjectPrx, Prx >, bool > = true>
std::optional< Prx >	uncheckedCast (const std::optional< ObjectPrx > &proxy, std::string facet)
	Creates a new proxy from an existing proxy.
std::string	UTF8ToNative (std::string_view str, const StringConverterPtr &nc)
	Converts the given string from UTF-8 to the native narrow string encoding using the given converter.
PluginFactory	wsPluginFactory ()
	Returns the factory for the WebSocket transport plug-in, IceWS.
std::string	wstringToString (const std::wstring &str, const StringConverterPtr &nc=nullptr, const WstringConverterPtr &wc=nullptr)
	Converts the given wide string to a narrow string.

Variables
constexpr std::int16_t	BTEndpointType = 6
	Identifies Bluetooth endpoints.
constexpr std::int16_t	BTSEndpointType = 7
	Identifies SSL Bluetooth endpoints.
constexpr EncodingVersion	currentEncoding {Encoding_1_1}
	Identifies the latest encoding version.
constexpr ProtocolVersion	currentProtocol {Protocol_1_0}
	Identifies the latest protocol version.
constexpr EncodingVersion	currentProtocolEncoding {Encoding_1_0}
	Identifies the latest protocol encoding version.
ICE_API const Current	emptyCurrent
	A default-initialized Current instance.
constexpr EncodingVersion	Encoding_1_0 {1, 0}
	Identifies encoding version 1.0.
constexpr EncodingVersion	Encoding_1_1 {1, 1}
	Identifies encoding version 1.1.
constexpr std::int16_t	iAPEndpointType = 8
	Identifies iAP-based endpoints.
constexpr std::int16_t	iAPSEndpointType = 9
	Identifies SSL iAP-based endpoints.
const Context	noExplicitContext
	Marker value used to indicate that no explicit request context was passed to a proxy invocation.
constexpr ProtocolVersion	Protocol_1_0 {1, 0}
	Identifies protocol version 1.0.
constexpr std::int16_t	SSLEndpointType = 2
	Identifies SSL endpoints.
constexpr StreamHelperCategory	StreamHelperCategoryBuiltin = 2
	Built-in types usually passed by reference.
constexpr StreamHelperCategory	StreamHelperCategoryBuiltinValue = 1
	Built-in types usually passed by value.
constexpr StreamHelperCategory	StreamHelperCategoryClass = 8
	Generated class types.
constexpr StreamHelperCategory	StreamHelperCategoryDictionary = 6
	Dictionary types.
constexpr StreamHelperCategory	StreamHelperCategoryEnum = 4
	Generated enum types.
constexpr StreamHelperCategory	StreamHelperCategoryProxy = 7
	Proxy types.
constexpr StreamHelperCategory	StreamHelperCategorySequence = 5
	Sequence types.
constexpr StreamHelperCategory	StreamHelperCategoryStruct = 3
	Generated struct types.
constexpr StreamHelperCategory	StreamHelperCategoryUnknown = 0
	Types with no StreamHelper specialization.
constexpr StreamHelperCategory	StreamHelperCategoryUserException = 9
	User exception types.
constexpr std::int16_t	TCPEndpointType = 1
	Identifies TCP endpoints.
constexpr std::int16_t	UDPEndpointType = 3
	Identifies UDP endpoints.
constexpr std::int16_t	URIEndpointType = 0
	Identifies endpoints marshaled as URI strings.
constexpr std::int16_t	WSEndpointType = 4
	Identifies TCP-based WebSocket endpoints.
constexpr std::int16_t	WSSEndpointType = 5
	Identifies SSL-based WebSocket endpoints.

Detailed Description

The Ice RPC framework.