Event notifications associated with Channel life-cycle. More...

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::ChannelRequester:

Collaboration diagram for epics::pvAccess::ChannelRequester:

Public Types
typedef std::tr1::shared_ptr < ChannelRequester >	shared_pointer

typedef std::tr1::shared_ptr < const ChannelRequester >	const_shared_pointer

typedef std::tr1::weak_ptr < ChannelRequester >	weak_pointer

typedef std::tr1::weak_ptr < const ChannelRequester >	const_weak_pointer

typedef Channel	operation_type

Public Member Functions
virtual void	channelCreated (const epics::pvData::Status &status, Channel::shared_pointer const &channel)=0
	The request made with ChannelProvider::createChannel() is satisfied. More...

virtual void	channelStateChange (Channel::shared_pointer const &channel, Channel::ConnectionState connectionState)=0
	Called occasionally after channelCreated() with Status::isOk() to give notification of connection state changes. More...

virtual std::tr1::shared_ptr < const PeerInfo >	getPeerInfo ()
	Return information on connected peer if applicable. More...

virtual std::string	getRequesterName ()=0
	The requester must have a name. More...

virtual void	message (std::string const &message, MessageType messageType=errorMessage)
	Push notification.

Static Public Attributes
static size_t	num_instances

Detailed Description

Event notifications associated with Channel life-cycle.

See ChannelProvider::createChannel()

Definition at line 1141 of file pvAccess.h.

Member Function Documentation

virtual void epics::pvAccess::ChannelRequester::channelCreated	(	const epics::pvData::Status &	status,
		Channel::shared_pointer const &	channel
	)

pure virtual

The request made with ChannelProvider::createChannel() is satisfied.

Will be called at most once for each call to createChannel().

The Channel passed here must be the same as was returned by createChannel(), if it has returned. Note that this method may be called before createChanel() returns.

Status::isOk() indicates that the Channel is valid. Calls to Channel methods can be made from this method, and later until Channel::destroy() is called.

!Status::isOk() indicates that the Channel is not available. No calls to the Channel are permitted. channelStateChange() will never be called.

Caller must hold no locks.

Parameters

status	Completion status.
channel	The channel.

Implemented in epics::pvAccess::DefaultChannelRequester.

virtual void epics::pvAccess::ChannelRequester::channelStateChange	(	Channel::shared_pointer const &	channel,
		Channel::ConnectionState	connectionState
	)

pure virtual

Called occasionally after channelCreated() with Status::isOk() to give notification of connection state changes.

Caller must hold no locks.

Parameters

c	The channel.
connectionState	The new connection state.

Implemented in epics::pvAccess::DefaultChannelRequester.

virtual std::tr1::shared_ptr<const PeerInfo> epics::pvAccess::ChannelRequester::getPeerInfo ( )

virtual

Return information on connected peer if applicable.

A server-type ChannelProvider will use this method to discover if a remote client has provided credentials which may be used in access control decisions.

Default implementation returns NULL.

isConnected()==true and getPeerInfo()==NULL when the ChannelProvider does not provide information about the peer. This should be treated as an unauthenticated, anonymous, peer.

The returned instance must not change, and a different instance should be returned if/when peer information changes (eg. after reconnect).

May return !NULL when !isConnected(). getPeerInfo() must be called before testing isConnected() in situations where connection state is being polled.

virtual std::string epics::pvAccess::Requester::getRequesterName ( )

pure virtualinherited

The requester must have a name.

Returns: The requester's name.

Implemented in epics::pvAccess::DefaultChannelRequester, and epics::pvAccess::Channel.

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

client/pv/pvAccess.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation