Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

SOAPBridge::ContextManager Interface Reference

The ContextManager interface. More...

#include <SoapBridge_public.idl>

Inheritance diagram for SOAPBridge::ContextManager:

SOAPBridge::ObjectContextManager List of all members.

Public Methods

SOAPContext allocateContext (in unsigned short timeoutSeconds, in string userData) raises ( InvalidTimeout )
 Used to obtain a new SOAP context. More...

SOAPContext queryContextInfo (in string contextKey) raises ( ContextKeyNotFound )
 Used to query the SOAP context. More...

void freeContext (in string contextKey) raises ( ContextKeyNotFound )
 Used to explicitely destroy a SOAP context. More...

void setContextUserData (in string contextKey, in string userData) raises ( ContextKeyNotFound )
 Used to store new or altered userData in a SOAP context. More...

void setContextTimeout (in string contextKey, in unsigned short timeoutSeconds) raises ( ContextKeyNotFound, InvalidTimeout )
 Used to change or reset the timeout of a SOAP context. More...


Detailed Description

The ContextManager interface.

See also:
SOAPBridge_ContextManager_i

Definition at line 31 of file SoapBridge_public.idl.


Member Function Documentation

SOAPContext SOAPBridge::ContextManager::allocateContext ( in unsigned short timeoutSeconds,
in string userData ) raises ( InvalidTimeout )
 

Used to obtain a new SOAP context.

Parameters:
timeoutSeconds   If there have been no references made to the context within this many seconds it will be destroyed.
userData   (optional) Application programmers can freely use this field to store any data they might need to keep between calls.
Exceptions:
InvalidTimeout  

void SOAPBridge::ContextManager::freeContext ( in string contextKey ) raises ( ContextKeyNotFound )
 

Used to explicitely destroy a SOAP context.

Parameters:
contextKey   The contextKey obtained from allocateContext
Exceptions:
ContextKeyNotFound  

SOAPContext SOAPBridge::ContextManager::queryContextInfo ( in string contextKey ) raises ( ContextKeyNotFound )
 

Used to query the SOAP context.

Note that this function does NOT reset the current timeout counter.

Parameters:
contextKey   The contextKey obtained from allocateContext
Exceptions:
ContextKeyNotFound  

void SOAPBridge::ContextManager::setContextTimeout ( in string contextKey,
in unsigned short timeoutSeconds ) raises ( ContextKeyNotFound, InvalidTimeout )
 

Used to change or reset the timeout of a SOAP context.

Parameters:
contextKey   The contextKey obtained from allocateContext
timeoutSeconds   New value for the timeout counter.
Exceptions:
InvalidTimeout  
ContextKeyNotFound  

void SOAPBridge::ContextManager::setContextUserData ( in string contextKey,
in string userData ) raises ( ContextKeyNotFound )
 

Used to store new or altered userData in a SOAP context.

Parameters:
contextKey   The contextKey obtained from allocateContext
userData   (optional) Application programmers can freely use this field to store any data they might need to keep between calls.
Exceptions:
ContextKeyNotFound  


The documentation for this interface was generated from the following file:
This documentation is part of the "SOAP to CORBA bridge" project
Copyright © 2000 by Lifeline Networks bv.
All rights are reserved.