Ice::InitializationData Struct Reference

Encapsulates data to initialize a communicator. More...

#include <Ice/Ice.h>

Public Attributes
std::function< void(const Ice::BatchRequest &req, int count, int size)>	batchRequestInterceptor
	The batch request interceptor, which is called by the Ice run time to enqueue a batch request. More...
std::function< std::string(int id)>	compactIdResolver
	Applications that make use of compact type IDs to conserve space when marshaling class instances, and also use the streaming API to extract such classes, can intercept the translation between compact type IDs and their corresponding string type IDs by installing a compact ID resolver. More...
std::function< void(std::function< void()> call, const std::shared_ptr< Ice::Connection > &con)>	dispatcher
	You can control which thread receives operation invocations and AMI callbacks by supplying a dispatcher. More...
LoggerPtr	logger
	The logger for the communicator. More...
Instrumentation::CommunicatorObserverPtr	observer
	The communicator observer used by the Ice run-time. More...
PropertiesPtr	properties
	The properties for the communicator. More...
std::function< void()>	threadStart
	Called whenever the communicator starts a new thread. More...
std::function< void()>	threadStop
	Called whenever a thread created by the communicator is about to be destroyed. More...
ValueFactoryManagerPtr	valueFactoryManager
	The value factory manager. More...

Detailed Description

Encapsulates data to initialize a communicator.

Member Data Documentation

batchRequestInterceptor

std::function<void(const Ice::BatchRequest& req, int count, int size)> Ice::InitializationData::batchRequestInterceptor

The batch request interceptor, which is called by the Ice run time to enqueue a batch request.

Parameters

req	An object representing the batch request.
count	The number of requests currently in the queue.
size	The number of bytes consumed by the requests currently in the queue.

compactIdResolver

std::function<std::string(int id)> Ice::InitializationData::compactIdResolver

Applications that make use of compact type IDs to conserve space when marshaling class instances, and also use the streaming API to extract such classes, can intercept the translation between compact type IDs and their corresponding string type IDs by installing a compact ID resolver.

Parameters

id	The compact ID.

Returns

The fully-scoped type ID such as "::Module::Class", or an empty string if the compact ID is unknown.

dispatcher

std::function<void(std::function<void()> call, const std::shared_ptr<Ice::Connection>& con)> Ice::InitializationData::dispatcher

You can control which thread receives operation invocations and AMI callbacks by supplying a dispatcher.

For example, you can use this dispatching facility to ensure that all invocations and callbacks are dispatched in a GUI event loop thread so that it is safe to invoke directly on GUI objects.

The dispatcher is responsible for running (dispatching) the invocation or AMI callback on its favorite thread.

Parameters

call	Represents the invocation. The dispatcher must eventually invoke this function.
con	The connection associated with this dispatch, or nil if no connection is associated with it.

logger

LoggerPtr Ice::InitializationData::logger

The logger for the communicator.

observer

Instrumentation::CommunicatorObserverPtr Ice::InitializationData::observer

The communicator observer used by the Ice run-time.

properties

PropertiesPtr Ice::InitializationData::properties

The properties for the communicator.

threadStart

std::function<void()> Ice::InitializationData::threadStart

Called whenever the communicator starts a new thread.

threadStop

std::function<void()> Ice::InitializationData::threadStop

Called whenever a thread created by the communicator is about to be destroyed.

valueFactoryManager

ValueFactoryManagerPtr Ice::InitializationData::valueFactoryManager

The value factory manager.

---

The documentation for this struct was generated from the following file:

• Ice/Initialize.h