epics::pvAccess::AuthenticationSession Class Reference

A particular authentication exchange. More...

#include <remote/pv/security.h>

Public Types
typedef std::tr1::shared_ptr< AuthenticationSession >	shared_pointer
typedef std::tr1::shared_ptr< const AuthenticationSession >	const_shared_pointer
typedef std::tr1::weak_ptr< AuthenticationSession >	weak_pointer
typedef std::tr1::weak_ptr< const AuthenticationSession >	const_weak_pointer

Public Member Functions
virtual epics::pvData::PVStructure::const_shared_pointer	initializationData ()
	For client plugins only, call to find the payload returned with CONNECTION_VALIDATION.
virtual void	messageReceived (epics::pvData::PVStructure::const_shared_pointer const &data)
	Called when an AUTHZ message is recieved from the peer.
virtual void	authenticationComplete (const epics::pvData::Status &status)
	For client plugins only.

Detailed Description

A particular authentication exchange.

See AuthenticationPlugin::createSession()

Note

Must not hold a strong reference to AuthenticationPluginControl

Definition at line 151 of file security.h.

Member Typedef Documentation

const_shared_pointer

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

Definition at line 154 of file security.h.

const_weak_pointer

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

Definition at line 154 of file security.h.

shared_pointer

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

Definition at line 154 of file security.h.

weak_pointer

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

Definition at line 154 of file security.h.

Member Function Documentation

authenticationComplete()

virtual void epics::pvAccess::AuthenticationSession::authenticationComplete ( const epics::pvData::Status & status )

inlinevirtual

For client plugins only.

Notification that server has declared the exchange complete.

Parameters

status	Check Status::isSuccess()
peer	Final information about pe

Definition at line 172 of file security.h.

initializationData()

virtual epics::pvData::PVStructure::const_shared_pointer epics::pvAccess::AuthenticationSession::initializationData ( )

inlinevirtual

For client plugins only, call to find the payload returned with CONNECTION_VALIDATION.

May return NULL.

Definition at line 160 of file security.h.

messageReceived()

virtual void epics::pvAccess::AuthenticationSession::messageReceived ( epics::pvData::PVStructure::const_shared_pointer const & data )

inlinevirtual

Called when an AUTHZ message is recieved from the peer.

See AuthenticationPluginControl::sendSecurityPluginMessage(). callee accepts ownership of data, which will not be modified.

Definition at line 166 of file security.h.

---

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

• remote/pv/security.h