This is Unofficial EPICS BASE Doxygen Site
epics::pvAccess::AuthenticationSession Class Reference

#include "security.h"

Public Member Functions

 POINTER_DEFINITIONS (AuthenticationSession)
 
virtual ~AuthenticationSession ()
 
virtual epics::pvData::PVStructure::const_shared_pointer initializationData ()
 
virtual void messageReceived (epics::pvData::PVStructure::const_shared_pointer const &data)
 
virtual void authenticationComplete (const epics::pvData::Status &status)
 

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.

Constructor & Destructor Documentation

epics::pvAccess::AuthenticationSession::~AuthenticationSession ( )
virtual

Definition at line 146 of file security.cpp.

146 {}

Member Function Documentation

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
statusCheck Status::isSuccess()
peerFinal information about pe

Definition at line 172 of file security.h.

172 {}
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.

161  { return epics::pvData::PVStructure::const_shared_pointer(); }
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.

166 {}
epics::pvAccess::AuthenticationSession::POINTER_DEFINITIONS ( AuthenticationSession  )

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