pvAccessCPP  7.1.1
Public Types | Public Member Functions | Static Public Member Functions | List of all members
epics::pvAccess::AuthenticationRegistry Class Reference

Registry(s) for plugins. More...

#include <remote/pv/security.h>

Public Types

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. More...
 
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. More...
 

Static Public Member Functions

static AuthenticationRegistry & clients ()
 The client side of the conversation.
 
static AuthenticationRegistry & servers ()
 The server side of the conversation.
 

Detailed Description

Registry(s) for plugins.

Definition at line 228 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: