pvAccessCPP  7.1.5
Public Member Functions | List of all members
epics::pvAccess::AuthenticationSession Class Reference

A particular authentication exchange. More...

#include <remote/pv/security.h>

Public Member Functions

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

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