pvAccessCPP 7.1.8
Loading...
Searching...
No Matches
epics::pvAccess::AuthenticationRegistry Class Reference

Registry(s) for plugins. More...

#include <remote/pv/security.h>

Public Types

typedef std::tr1::shared_ptr< AuthenticationRegistryshared_pointer
 
typedef std::tr1::shared_ptr< const AuthenticationRegistryconst_shared_pointer
 
typedef std::tr1::weak_ptr< AuthenticationRegistryweak_pointer
 
typedef std::tr1::weak_ptr< const AuthenticationRegistryconst_weak_pointer
 
typedef std::vector< map_t::mapped_type > list_t
 

Public Member Functions

void snapshot (list_t &plugmap) const
 Save a copy of the current registry in order of increasing priority.
 
void add (int prio, const std::string &name, const AuthenticationPlugin::shared_pointer &plugin)
 Add a new plugin to this registry.
 
bool remove (const AuthenticationPlugin::shared_pointer &plugin)
 Remove an existing entry. Remove true if the entry was actually removed.
 
AuthenticationPlugin::shared_pointer lookup (const std::string &name) const
 Fetch a single plugin explicitly by name.
 

Static Public Member Functions

static AuthenticationRegistryclients ()
 The client side of the conversation.
 
static AuthenticationRegistryservers ()
 The server side of the conversation.
 

Detailed Description

Registry(s) for plugins.

Definition at line 228 of file security.h.

Member Typedef Documentation

◆ const_shared_pointer

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

Definition at line 232 of file security.h.

◆ const_weak_pointer

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

Definition at line 232 of file security.h.

◆ list_t

Definition at line 239 of file security.h.

◆ shared_pointer

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

Definition at line 232 of file security.h.

◆ weak_pointer

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

Definition at line 232 of file security.h.

Constructor & Destructor Documentation

◆ AuthenticationRegistry()

epics::pvAccess::AuthenticationRegistry::AuthenticationRegistry ( )
inline

Definition at line 246 of file security.h.

Member Function Documentation

◆ add()

void epics::pvAccess::AuthenticationRegistry::add ( int prio,
const std::string & name,
const AuthenticationPlugin::shared_pointer & plugin )

Add a new plugin to this registry.

Parameters
prioOrder in which plugins are considered. highest is preferred.
nameName under which this plugin will be known
pluginPlugin instance

◆ lookup()

AuthenticationPlugin::shared_pointer epics::pvAccess::AuthenticationRegistry::lookup ( const std::string & name) const

Fetch a single plugin explicitly by name.

Returns
NULL if no entry for this name is available.

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