OpenGL Vizserver Reference Page


NAME
vsAuth - Authentication container

INHERITS FROM
vsLoadable

HEADER FILE
#include <vizserver/vsAuth.h>

PUBLIC METHOD SUMMARY

   Destruction
virtual ~vsAuth (  );

   Field Creation
vsStatus createFields ( vsAuthFieldSet*& fields) const;
virtual vsStatus createContext ( const char* hostname, const char* service, const vsAuthFieldSet* fields, vsAuthContext*& context) const = 0;
virtual vsStatus createContext ( const char* service, const void* data, unsigned int length, vsAuthContext*& context) const = 0;

   Getting
const char* getName (  ) const;

PROTECTED METHOD SUMMARY
vsAuth (  );
virtual vsStatus addFields ( vsAuthFieldSet*& fields) const;

CLASS DESCRIPTION
Authentication container

METHOD DESCRIPTIONS

   vsAuth()
vsAuth (  );

Constructor

   ~vsAuth()
virtual ~vsAuth (  );

Destroys the vsAuth object and associated data.

   addFields()
virtual vsStatus addFields ( vsAuthFieldSet*& fields) const;

The workhorse function for adding fields to an authentication context. Takes in an allocated field set, and adds the required fields to it.

   createContext()
virtual vsStatus createContext ( const char* hostname, const char* service, const vsAuthFieldSet* fields, vsAuthContext*& context) const = 0;

Client side authentication initialization.

   createContext()
virtual vsStatus createContext ( const char* service, const void* data, unsigned int length, vsAuthContext*& context) const = 0;

Server side authentication initialization.

   createFields()
vsStatus createFields ( vsAuthFieldSet*& fields) const;

Create the list of fields that go with a specific authentication type. Calls the addField protected method.

   getName()
const char* getName (  ) const;

Returns the name of the authentication module.

SEE ALSO
vsLoadable