pvAccessCPP 7.1.8
Loading...
Searching...
No Matches
epics::pvAccess::AuthenticationPlugin Class Referenceabstract

Actor through which authentication exchanges are initiated. More...

#include <remote/pv/security.h>

Public Types

typedef std::tr1::shared_ptr< AuthenticationPluginshared_pointer
 
typedef std::tr1::shared_ptr< const AuthenticationPluginconst_shared_pointer
 
typedef std::tr1::weak_ptr< AuthenticationPluginweak_pointer
 
typedef std::tr1::weak_ptr< const AuthenticationPluginconst_weak_pointer
 

Public Member Functions

virtual bool isValidFor (const PeerInfo &peer) const
 Allow this plugin to be advertised to a particular peer.
 
virtual std::tr1::shared_ptr< AuthenticationSessioncreateSession (const std::tr1::shared_ptr< PeerInfo > &peer, std::tr1::shared_ptr< AuthenticationPluginControl > const &control, epics::pvData::PVStructure::shared_pointer const &data)=0
 Begin a new session with a peer.
 

Detailed Description

Actor through which authentication exchanges are initiated.

Definition at line 198 of file security.h.

Member Typedef Documentation

◆ const_shared_pointer

std::tr1::shared_ptr<const AuthenticationPlugin> epics::pvAccess::AuthenticationPlugin::const_shared_pointer

Definition at line 201 of file security.h.

◆ const_weak_pointer

std::tr1::weak_ptr<const AuthenticationPlugin> epics::pvAccess::AuthenticationPlugin::const_weak_pointer

Definition at line 201 of file security.h.

◆ shared_pointer

std::tr1::shared_ptr<AuthenticationPlugin> epics::pvAccess::AuthenticationPlugin::shared_pointer

Definition at line 201 of file security.h.

◆ weak_pointer

std::tr1::weak_ptr<AuthenticationPlugin> epics::pvAccess::AuthenticationPlugin::weak_pointer

Definition at line 201 of file security.h.

Member Function Documentation

◆ createSession()

virtual std::tr1::shared_ptr< AuthenticationSession > epics::pvAccess::AuthenticationPlugin::createSession ( const std::tr1::shared_ptr< PeerInfo > & peer,
std::tr1::shared_ptr< AuthenticationPluginControl > const & control,
epics::pvData::PVStructure::shared_pointer const & data )
pure virtual

Begin a new session with a peer.

Parameters
peerPartially initialized PeerInfo. See isValidFor(). PeerInfo::authority is also set. Caller transfers ownership to callee, which may modify.
controlcallee uses to asynchronously continue, and complete the session.
dataAlways NULL for client-type plugins. For server-type plugins, the result of initializationData() from the peer

◆ isValidFor()

virtual bool epics::pvAccess::AuthenticationPlugin::isValidFor ( const PeerInfo & peer) const
inlinevirtual

Allow this plugin to be advertised to a particular peer.

At this point the PeerInfo has only been partially initialized with transport/protocol specific information: PeerInfo::peer, PeerInfo::transport, and PeerInfo::transportVersion.

Definition at line 209 of file security.h.


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