zmqpp::zap_request Class Reference

A class for working with ZAP requests and replies. More...

#include <zap_request.hpp>

Collaboration diagram for zmqpp::zap_request:

Public Member Functions
	zap_request (socket &handler, bool logging)
	Receive a ZAP valid request from the handler socket. More...
void	reply (const std::string &status_code, const std::string &status_text, const std::string &user_id)
	Send a ZAP reply to the handler socket. More...
const std::string &	get_version () const
	Get Version. More...
const std::string &	get_domain () const
	Get Domain. More...
const std::string &	get_address () const
	Get Address. More...
const std::string &	get_identity () const
	Get Identity. More...
const std::string &	get_mechanism () const
	Get Security Mechanism. More...
const std::string &	get_username () const
	Get username for PLAIN security mechanism. More...
const std::string &	get_password () const
	Get password for PLAIN security mechanism. More...
const std::string &	get_client_key () const
const std::string &	get_principal () const
	Get principal for GSSAPI security mechanism. More...

Private Member Functions
	zap_request (zap_request const &) ZMQPP_EXPLICITLY_DELETED
zap_request &	operator= (zap_request const &) NOEXCEPT ZMQPP_EXPLICITLY_DELETED

Private Attributes
socket &	zap_socket
	Socket we're talking to. More...
std::string	version
	Version number, must be "1.0". More...
std::string	sequence
	Sequence number of request. More...
std::string	domain
	Server socket domain. More...
std::string	address
	Client IP address. More...
std::string	identity
	Server socket idenntity. More...
std::string	mechanism
	Security mechansim. More...
std::string	username
	PLAIN user name. More...
std::string	password
	PLAIN password, in clear text. More...
std::string	client_key
	CURVE client public key in ASCII. More...
std::string	principal
	GSSAPI client principal. More...
bool	verbose
	Log ZAP requests and replies? More...

Detailed Description

A class for working with ZAP requests and replies.

Used in auth to simplify working with RFC 27 messages.

Constructor & Destructor Documentation

zmqpp::zap_request::zap_request	(	socket &	handler,
		bool	logging
	)

Receive a ZAP valid request from the handler socket.

Receive a ZAP valid request from the handler socket

zmqpp::zap_request::zap_request ( zap_request const &  )

private

Member Function Documentation

const std::string& zmqpp::zap_request::get_address ( ) const

inline

Get Address.

const std::string& zmqpp::zap_request::get_client_key ( ) const

inline

Get client_key for CURVE security mechanism. The key is z85 encoded.

const std::string& zmqpp::zap_request::get_domain ( ) const

inline

Get Domain.

const std::string& zmqpp::zap_request::get_identity ( ) const

inline

Get Identity.

const std::string& zmqpp::zap_request::get_mechanism ( ) const

inline

Get Security Mechanism.

const std::string& zmqpp::zap_request::get_password ( ) const

inline

Get password for PLAIN security mechanism.

const std::string& zmqpp::zap_request::get_principal ( ) const

inline

Get principal for GSSAPI security mechanism.

const std::string& zmqpp::zap_request::get_username ( ) const

inline

Get username for PLAIN security mechanism.

const std::string& zmqpp::zap_request::get_version ( ) const

inline

Get Version.

zap_request& zmqpp::zap_request::operator= ( zap_request const &  )

private

void zmqpp::zap_request::reply	(	const std::string &	status_code,
		const std::string &	status_text,
		const std::string &	user_id
	)

Send a ZAP reply to the handler socket.

Send a ZAP reply to the handler socket

Member Data Documentation

std::string zmqpp::zap_request::address

private

Client IP address.

std::string zmqpp::zap_request::client_key

private

CURVE client public key in ASCII.

std::string zmqpp::zap_request::domain

private

Server socket domain.

std::string zmqpp::zap_request::identity

private

Server socket idenntity.

std::string zmqpp::zap_request::mechanism

private

Security mechansim.

std::string zmqpp::zap_request::password

private

PLAIN password, in clear text.

std::string zmqpp::zap_request::principal

private

GSSAPI client principal.

std::string zmqpp::zap_request::sequence

private

Sequence number of request.

std::string zmqpp::zap_request::username

private

PLAIN user name.

bool zmqpp::zap_request::verbose

private

Log ZAP requests and replies?

std::string zmqpp::zap_request::version

private

Version number, must be "1.0".

socket& zmqpp::zap_request::zap_socket

private

Socket we're talking to.

---

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

• src/zmqpp/zap_request.hpp
• src/zmqpp/zap_request.cpp