INTRODUCTION
Overview
Download and Install
Quick Start
Documentation
Publications

NONFRAMEWORK CODE
Driver Interfaces
Drivers
Libraries
Utilities

FRAMEWORK CODE
Interfaces
Components
Libraries
Utilities

Full Software Listings

DEVELOPER
Tutorials
Examples
Dev Guide
Dashboard

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

orcaicegrid::IceGridSession Class Reference

Creates and maintains an IceGrid admin session. More...

#include <icegridsession.h>

Inherited by orcaicegrid::IceGridManager.

List of all members.

Public Types

enum  SessionState { Disconnected, Connecting, Connected, Disconnecting }
 

State of the Session.

More...

Public Member Functions

 IceGridSession (const orcaice::Context &context, const IceGrid::RegistryObserverPrx &reg=IceGrid::RegistryObserverPrx(), const IceGrid::NodeObserverPrx &node=IceGrid::NodeObserverPrx(), const IceGrid::ApplicationObserverPrx &app=IceGrid::ApplicationObserverPrx(), const IceGrid::AdapterObserverPrx &adpt=IceGrid::AdapterObserverPrx(), const IceGrid::ObjectObserverPrx &obj=IceGrid::ObjectObserverPrx())
SessionState getState ()
 Returns current state of the session. Thread-safe.
void setObservers (const IceGrid::RegistryObserverPrx &reg=IceGrid::RegistryObserverPrx(), const IceGrid::NodeObserverPrx &node=IceGrid::NodeObserverPrx(), const IceGrid::ApplicationObserverPrx &app=IceGrid::ApplicationObserverPrx(), const IceGrid::AdapterObserverPrx &adpt=IceGrid::AdapterObserverPrx(), const IceGrid::ObjectObserverPrx &obj=IceGrid::ObjectObserverPrx())
virtual bool connectedEvent ()
virtual void disconnectedEvent ()

Detailed Description

Creates and maintains an IceGrid admin session.

Author:
Alex Brooks

Member Enumeration Documentation

State of the Session.

Enumerator:
Disconnected 

Disconnected.

Connecting 

Connecting.

Connected 

Connected.

Disconnecting 

Disconnecting.


Constructor & Destructor Documentation

orcaicegrid::IceGridSession::IceGridSession ( const orcaice::Context context,
const IceGrid::RegistryObserverPrx &  reg = IceGrid::RegistryObserverPrx(),
const IceGrid::NodeObserverPrx &  node = IceGrid::NodeObserverPrx(),
const IceGrid::ApplicationObserverPrx &  app = IceGrid::ApplicationObserverPrx(),
const IceGrid::AdapterObserverPrx &  adpt = IceGrid::AdapterObserverPrx(),
const IceGrid::ObjectObserverPrx &  obj = IceGrid::ObjectObserverPrx() 
)

Constructor.

The session will automatically register these observers the next time (and every time) session is created. Pass an null proxy in place of an observer which you don't want to register.

References Disconnected.


Member Function Documentation

virtual bool orcaicegrid::IceGridSession::connectedEvent (  )  [inline, virtual]

Reimplement this to perform custom action right after a new session is created. Returns TRUE if successful. On FALSE the session is destroyed and another one is created.

Reimplemented in orcaicegrid::IceGridManager.

virtual void orcaicegrid::IceGridSession::disconnectedEvent (  )  [inline, virtual]

Reimplement this to perform custom action right after a existing session was lost (intentionally or not). (No value is returned because nothing can be done if something does go wrong).

Reimplemented in orcaicegrid::IceGridManager.

void orcaicegrid::IceGridSession::setObservers ( const IceGrid::RegistryObserverPrx &  reg = IceGrid::RegistryObserverPrx(),
const IceGrid::NodeObserverPrx &  node = IceGrid::NodeObserverPrx(),
const IceGrid::ApplicationObserverPrx &  app = IceGrid::ApplicationObserverPrx(),
const IceGrid::AdapterObserverPrx &  adpt = IceGrid::AdapterObserverPrx(),
const IceGrid::ObjectObserverPrx &  obj = IceGrid::ObjectObserverPrx() 
)

Set the observer proxies that receive notifications when the state of the registry or nodes changes. Calls the corresponding method of the Admin session. Catches the ObserverAlreadyRegisteredException exception. If the session has already been created, the observers are registered with the session. If the session does not exist, local variables are set and registration will happen the next time the session is created.


The documentation for this class was generated from the following files:
 

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)


Generated for Orca Robotics by  doxygen 1.4.5