This is Unofficial EPICS BASE Doxygen Site
epics::pvAccess::ChannelFindRequester Class Referenceabstract

#include "pvAccess.h"

+ Inheritance diagram for epics::pvAccess::ChannelFindRequester:

Public Types

typedef ChannelFind operation_type
 

Public Member Functions

 POINTER_DEFINITIONS (ChannelFindRequester)
 
virtual ~ChannelFindRequester ()
 
virtual void channelFindResult (const epics::pvData::Status &status, ChannelFind::shared_pointer const &channelFind, bool wasFound)=0
 
virtual std::tr1::shared_ptr< const PeerInfogetPeerInfo ()
 Return information on requesting peer if applicable. More...
 

Detailed Description

Definition at line 426 of file pvAccess.h.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual epics::pvAccess::ChannelFindRequester::~ChannelFindRequester ( )
inlinevirtual

Definition at line 431 of file pvAccess.h.

431 {}

Member Function Documentation

virtual void epics::pvAccess::ChannelFindRequester::channelFindResult ( const epics::pvData::Status status,
ChannelFind::shared_pointer const &  channelFind,
bool  wasFound 
)
pure virtual
Parameters
statusCompletion status.

Implemented in epics::pvAccess::ServerChannelFindRequesterImpl.

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

Return information on requesting 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.

The returned PeerInfo is only required to have valid values for: peer, transport, and transportVersion. PeerInfo::authority may be empty if authentication has not yet occured (UDP search).

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.

Reimplemented in epics::pvAccess::ServerChannelFindRequesterImpl.

Definition at line 462 of file pvAccess.h.

463  { return std::tr1::shared_ptr<const PeerInfo>(); }
epics::pvAccess::ChannelFindRequester::POINTER_DEFINITIONS ( ChannelFindRequester  )

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