epics::pvAccess::AuthenticationRegistry Class Reference

#include "security.h"

Public Types
typedef std::vector< map_t::mapped_type >	list_t

Public Member Functions
	AuthenticationRegistry ()
	~AuthenticationRegistry ()
void	snapshot (list_t &plugmap) const
	Save a copy of the current registry in order of increasing priority. More...
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. More...
AuthenticationPlugin::shared_pointer	lookup (const std::string &name) const

Static Public Member Functions
static AuthenticationRegistry &	clients ()
	The client side of the conversation. More...
static AuthenticationRegistry &	servers ()
	The server side of the conversation. More...

Detailed Description

Registry(s) for plugins

Definition at line 228 of file security.h.

Member Typedef Documentation

typedef std::vector<map_t::mapped_type> epics::pvAccess::AuthenticationRegistry::list_t

Definition at line 239 of file security.h.

Constructor & Destructor Documentation

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

inline

Definition at line 246 of file security.h.

{}

epics::pvAccess::AuthenticationRegistry::~AuthenticationRegistry

(

)

Definition at line 152 of file security.cpp.

{}

Member Function Documentation

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

Add a new plugin to this registry.

Parameters

prio	Order in which plugins are considered. highest is preferred.
name	Name under which this plugin will be known
plugin	Plugin instance

Definition at line 221 of file security.cpp.

{
    Guard G(mutex);
    if(map.find(prio)!=map.end())
        THROW_EXCEPTION2(std::logic_error, "Authentication plugin already registered with this priority");
    map[prio] = std::make_pair(name, plugin);
}

AuthenticationRegistry & epics::pvAccess::AuthenticationRegistry::clients ( )

static

The client side of the conversation.

Definition at line 197 of file security.cpp.

{
    epicsThreadOnce(&authGblOnce, &authGblInit, 0);
    assert(authGbl);
    return authGbl->clients;
}

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.

Definition at line 242 of file security.cpp.

{
    Guard G(mutex);
    // assuming the number of plugins is small, we don't index by name.
    for(map_t::const_iterator it(map.begin()), end(map.end()); it!=end; ++it) {
        if(it->second.first==name)
            return it->second.second;
    }
    return AuthenticationPlugin::shared_pointer();
}

bool epics::pvAccess::AuthenticationRegistry::remove

(

const AuthenticationPlugin::shared_pointer &

plugin

)

Remove an existing entry. Remove true if the entry was actually removed.

Definition at line 230 of file security.cpp.

{
    Guard G(mutex);
    for(map_t::iterator it(map.begin()), end(map.end()); it!=end; ++it) {
        if(it->second.second==plugin) {
            map.erase(it);
            return true;
        }
    }
    return false;
}

AuthenticationRegistry & epics::pvAccess::AuthenticationRegistry::servers ( )

static

The server side of the conversation.

Definition at line 204 of file security.cpp.

{
    epicsThreadOnce(&authGblOnce, &authGblInit, 0);
    assert(authGbl);
    return authGbl->servers;
}

void epics::pvAccess::AuthenticationRegistry::snapshot

(

list_t &

plugmap

)

const

Save a copy of the current registry in order of increasing priority.

Definition at line 211 of file security.cpp.

{
    plugmap.clear();
    Guard G(mutex);
    plugmap.reserve(map.size());
    for(map_t::const_iterator it(map.begin()), end(map.end()); it!=end; ++it) {
        plugmap.push_back(it->second);
    }
}

---

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

• modules/pvAccess/src/remote/pv/security.h
• modules/pvAccess/src/remote/security.cpp