AccessGrid.VenueClient.VenueClient

Package AccessGrid :: Module VenueClient :: Class VenueClient

[show private | hide private]

Class VenueClient

Known Subclasses:: MyVenueClient

This is the client side object that maintains a stateful relationship with a Virtual Venue. This object provides the programmatic interface to the Access Grid for a Venues User Interface. The VenueClient can only be in one venue at a time.

Method Summary
	`__init__(self, profile, pnode, port, progressCB, app)` This client class is used on shared and personal nodes.
	`AddApplicationEvent(self, event)`
	`AddConnectionEvent(self, event)`
	`AddDataEvent(self, event)`
	`AddObserver(self, observer)`
	`AddService(self, serviceDescription)`
	`AddServiceEvent(self, event)`
	`AddStreamEvent(self, event)`
	`AddTextEvent(self, name, text)`
	`AddUserEvent(self, event)`
	`CreateApplication(self, appName, appDescription, appMimeType)`
	`DestroyApplication(self, appId)`
	`EnterVenue(self, URL)` EnterVenue puts this client into the specified venue.
	`ExitVenue(self)` ExitVenue removes this client from the specified venue.
	`GetApplications(self)`
	`GetConnections(self)`
	`GetDataStoreInformation(self)` Retrieve an upload descriptor and a URL to personal DataStore
	`GetDataStoreUploadUrl(self)`
	`GetEventChannelId(self)`
	`GetNetworkLocationProviders(self)` GetNetworkLocationProviders returns a list of entities providing network locations to the current venue.
	`GetNodeServiceUri(self)`
	`GetNodeServiceURL(self)`
	`GetPersonalData(self, clientProfile)` Get personal data from client...
	`GetProfile(self)`
	`GetProvider(self)`
	`GetServices(self)`
	`GetStreams(self)`
	`GetTransport(self)`
	`GetTransportList(self)`
	`GetUsers(self)`
	`GetVenue(self)` GetVenue gets the venue the client is currently in.
	`GetVenueData(self)`
	`GetVenueDescription(self)`
	`GetVenueName(self)`
	`GetVenueState(self)`
	`GetVenueStreams(self)`
	`GetVenueURL(self)`
	`GetWebServiceUrl(self)`
	`IsInVenue(self)`
	`IsVenueAdministrator(self)`
	`ModifyStreamEvent(self, event)`
	`ModifyUserEvent(self, event)`
	`OpenAppEvent(self, event)`
	`RemoveApplicationEvent(self, event)`
	`RemoveConnectionEvent(self, event)`
	`RemoveData(self, data)` This method removes a data from the venue.
	`RemoveDataEvent(self, event)`
	`RemoveService(self, serviceDescription)`
	`RemoveServiceEvent(self, event)`
	`RemoveStreamEvent(self, event)`
	`RemoveUserEvent(self, event)`
	`SaveProfile(self)`
	`SendEvent(self, event)`
	`SendText(self, text)`
	`SetAudioEnabled(self, enableFlag)`
	`SetConnectionsEvent(self, event)`
	`SetNodeUrl(self, url)` This method sets the node service url
	`SetProfile(self, profile)`
	`SetProvider(self, provider)`
	`SetTransport(self, transport)`
	`SetVideoEnabled(self, enableFlag)`
	`Shutdown(self)`
	`SOAPFaultHandler(self, proxy, ex)` Handle a fault raised by an invocation through the venue server proxy.
	`UpdateApplication(self, appDescription)`
	`UpdateApplicationEvent(self, event)`
	`UpdateClientProfile(self, profile)`
	`UpdateData(self, data)`
	`UpdateDataEvent(self, event)`
	`UpdateNodeService(self)` Send venue streams to the node service
	`UpdateProfileCache(self, profile)`
	`UpdateService(self, serviceDescription)`
	`UpdateServiceEvent(self, event)`
	`UpdateStream(self, stream)` Apply selections of transport and netloc provider to the given stream.

Class Variable Summary
`str`	`defaultNodeServiceUri` = `'https://localhost:11000/NodeSer...`

Method Details

init(self, profile=None, pnode=0, port=0, progressCB=None, app=None)
(Constructor)

This client class is used on shared and personal nodes.

EnterVenue(self, URL)

EnterVenue puts this client into the specified venue.

URL : url to the venue

ExitVenue(self)

ExitVenue removes this client from the specified venue.

GetDataStoreInformation(self)

Retrieve an upload descriptor and a URL to personal DataStore

**Returns:**

*(upload description, url)* the upload descriptor to the DataStore and the url to the DataStore SOAP service.

GetNetworkLocationProviders(self)

GetNetworkLocationProviders returns a list of entities providing
network locations to the current venue.

Note:  To do this, it looks for providers in the first stream.
       For now, this assumption is safe.

GetPersonalData(self, clientProfile=None)

Get personal data from client

**Arguments**
    *clientProfile* of the person we want to get data from

GetVenue(self)

GetVenue gets the venue the client is currently in.

RemoveData(self, data)

This method removes a data from the venue. If the data is personal, this method also removes the data from the personal data storage.

**Arguments:**

*data* The DataDescription we want to remove from vnue

SetNodeUrl(self, url)

This method sets the node service url

**Arguments:**

*url* The string including the new node url address

SOAPFaultHandler(self, proxy, ex)

Handle a fault raised by an invocation through the venue server proxy.

Parameters:: proxy - SOAPpy proxy through which the invocation failed; ex - The exception that was raised

Returns:: a true value if the invocation should be retried.

UpdateNodeService(self)

Send venue streams to the node service

UpdateStream(self, stream)

Apply selections of transport and netloc provider to the given stream.

Class Variable Details

defaultNodeServiceUri

Type:: str
Value:: 'https://localhost:11000/NodeService'

Generated by Epydoc 2.1 on Thu Apr 14 16:39:29 2005

http://epydoc.sf.net