Ice 3.7 C++11 API Reference
|
Go to the documentation of this file.
5 #ifndef GLACIER2_SESSION_HELPER_H
6 #define GLACIER2_SESSION_HELPER_H
39 #ifndef ICE_CPP11_MAPPING
72 virtual Ice::ObjectPrxPtr
addWithUUID(
const Ice::ObjectPtr& servant) = 0;
78 virtual SessionPrxPtr
session()
const = 0;
94 #ifndef ICE_CPP11_MAPPING
107 #ifndef ICE_CPP11_MAPPING
142 class SessionThreadCallback;
150 #ifdef ICE_CPP11_MAPPING
151 :
public std::enable_shared_from_this<SessionFactoryHelper>
157 friend class SessionThreadCallback;
216 void setSecure(
bool);
218 bool getSecure() const;
225 void setProtocol(const std::
string& protocol);
231 std::
string getProtocol() const;
237 void setTimeout(
int timeout);
243 int getTimeout() const;
249 void setPort(
int port);
261 Ice::InitializationData getInitializationData() const;
267 void setConnectContext(const std::map<std::
string, std::
string>& context);
273 void setUseCallbacks(
bool b);
279 bool getUseCallbacks() const;
297 Ice::InitializationData createInitData();
298 std::
string getRouterFinderStr();
299 int getPortInternal() const;
300 std::
string createProxyStr(const
Ice::Identity& ident);
301 void setDefaultProperties();
304 std::
string _routerHost;
305 Ice::Identity _identity;
306 std::
string _protocol;
309 Ice::InitializationData _initData;
311 std::map<std::
string, std::
string> _context;
bool operator!=(const C &lhs, const C &rhs)
Relational operator for generated structs and classes.
Definition: Comparable.h:196
virtual bool isConnected() const =0
Determines whether the session is active.
#define GLACIER2_API
Definition: PermissionsVerifierF.h:50
Allows an application to receive notification about events in the lifecycle of a Glacier2 session.
Definition: SessionHelper.h:110
virtual Ice::CommunicatorPtr communicator() const =0
Obtains the communicator created by the SessionHelper.
#define ICE_DEFINE_PTR(TPtr, T)
Definition: Config.h:359
Encapsulates a Glacier2 session and provides much of the same functionality as Glacier2::Application ...
Definition: SessionHelper.h:42
Ice::Identity getRouterIdentity() const
Obtains the object identity of the Glacier2 router.
#define ICE_DEPRECATED_API(msg)
Definition: Config.h:217
::std::shared_ptr< SessionHelper > SessionHelperPtr
Definition: SessionHelper.h:100
bool operator==(const C &lhs, const C &rhs)
Relational operator for generated structs and classes.
Definition: Comparable.h:184
std::string getRouterHost() const
Obtains the host name of the Glacier2 router.
virtual void disconnected(const SessionHelperPtr &session)=0
Called after the Glacier2 session is destroyed.
::std::shared_ptr< SessionCallback > SessionCallbackPtr
Definition: SessionHelper.h:139
Definition: Optional.h:1095
SessionFactoryHelper(const Ice::InitializationData &initData, const SessionCallbackPtr &callback)
Use this constructor when you want to provide your own instance of InitializationData.
const int GLACIER2_SSL_PORT
The IANA-registered port number for Glacier2 via SSL.
Definition: SessionHelper.h:29
virtual void destroy()=0
Initiates the destruction of the Glacier2 session, including the communicator created by the SessionH...
Definition: PermissionsVerifier.h:66
virtual void connected(const SessionHelperPtr &session)=0
Called after successfully establishing the Glacier2 session.
const int GLACIER2_TCP_PORT
The IANA-registered port number for Glacier2 via TCP.
Definition: SessionHelper.h:31
virtual Ice::ObjectPrxPtr addWithUUID(const Ice::ObjectPtr &servant)=0
Adds a servant to the callback object adapter using a UUID for the identity name.
virtual Ice::ObjectAdapterPtr objectAdapter()=0
Obtains the callback object adapter.
void setRouterIdentity(const Ice::Identity &identity)
Sets the object identity of the Glacier2 router.
Abstract base class for all Ice exceptions.
Definition: Exception.h:22
Definition: BuiltinSequences.h:56
SessionFactoryHelper(const SessionCallbackPtr &callback)
This constructor is useful when your application has no other configuration requirements.
virtual SessionPrxPtr session() const =0
Obtains a proxy for the Glacier2 session.
virtual void createdCommunicator(const SessionHelperPtr &session)=0
Called after successfully initializing a communicator.
::std::shared_ptr< SessionFactoryHelper > SessionFactoryHelperPtr
Definition: SessionHelper.h:315
void setRouterHost(const std::string &host)
Sets the host name of the Glacier2 router.
Handle< Thread > ThreadPtr
Definition: Thread.h:156
virtual void connectFailed(const SessionHelperPtr &session, const Ice::Exception &ex)=0
Called if a failure occurred while attempting to establish a Glacier2 session.
virtual std::string categoryForClient() const =0
Obtains the category that must be used in the identities of all callback objects.
Facilitates the creation of new Glacier2 sessions.
Definition: SessionHelper.h:155
virtual ~SessionCallback()
Encapsulates data to initialize a communicator.
Definition: Initialize.h:279
The identity of an Ice object.
Definition: Identity.h:67
SessionFactoryHelper(const Ice::PropertiesPtr &properties, const SessionCallbackPtr &callback)
This constructor is convenient when you want to supply an initial set of properties.
void destroy()
Blocks until all background threads are terminated.