Smartswitch
Operations | List of all members
Smartswitch::Peer::GenericPeer Interface Reference

This is a generic interface to each of the peers. More...

defined in <GenericPeer.ice>

interface GenericPeer extends Smartswitch::Destroyable { ... }

Inheritance diagram for Smartswitch::Peer::GenericPeer:
Inheritance graph
[legend]
Collaboration diagram for Smartswitch::Peer::GenericPeer:
Collaboration graph
[legend]

Operations

CompanygetCompany () throws AccessException
 Obtain the proxy to a Company which is bound to this GenericPeer. More...
 
idempotent long getId ()
 Obtain the unique constant ID of a GenericPeer. More...
 
idempotent string getName () throws AccessException
 Obtain the name of a GenericPeer. More...
 
VariableSequence getVariables () throws AccessException
 Obtain the custom variables attached to the GenericPeer. More...
 
void insertVariable (Variable variable) throws AccessException
 Add a custom variable to the GenericPeer. More...
 
- Operations inherited from Smartswitch::Destroyable
void destroy ()
 Destroy the proxy entity at the Smartswitch side. More...
 

Detailed Description

This is a generic interface to each of the peers.

Operation Documentation

◆ getCompany()

Company* getCompany ( ) throws AccessException

Obtain the proxy to a Company which is bound to this GenericPeer.

Returns
The proxy to a Company.

◆ getId()

idempotent long getId ( )

Obtain the unique constant ID of a GenericPeer.

Returns
unique ID of a GenericPeer.

◆ getName()

idempotent string getName ( ) throws AccessException

Obtain the name of a GenericPeer.

Returns
name of a GenericPeer.

◆ getVariables()

VariableSequence getVariables ( ) throws AccessException

Obtain the custom variables attached to the GenericPeer.

The custom variables can be used in a custom call handler.

Returns
The sequence of Variable objects attached to the GenericPeer.

◆ insertVariable()

void insertVariable ( Variable  variable) throws AccessException

Add a custom variable to the GenericPeer.

See also
getVariables.
Parameters
variableThe Variable object which will be attached to the GenericPeer.

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