#include <cromp_client.h>

Inheritance diagram for cromp::cromp_client:

Collaboration diagram for cromp::cromp_client:

Public Types
enum	constraints { DEFAULT_MAX_CONNECT_WAIT = 28 * basis::SECOND_ms , DEFAULT_MAX_RESPONSE_WAIT = 4 * basis::MINUTE_ms }

Public Types inherited from cromp::cromp_common
enum	outcomes { OKAY = basis::common::OKAY , DISALLOWED = basis::common::DISALLOWED , BAD_INPUT = basis::common::BAD_INPUT , NOT_FOUND = basis::common::NOT_FOUND , TIMED_OUT = basis::common::TIMED_OUT , GARBAGE = basis::common::GARBAGE , NO_HANDLER = basis::common::NO_HANDLER , PARTIAL = basis::common::PARTIAL , ENCRYPTION_MISMATCH = basis::common::ENCRYPTION_MISMATCH , NO_SERVER = sockets::communication_commons::NO_SERVER , NO_CONNECTION = sockets::communication_commons::NO_CONNECTION }

Public Member Functions
	cromp_client (const sockets::internet_address &destination, int connection_wait=DEFAULT_MAX_CONNECT_WAIT, int max_per_ent=DEFAULT_MAX_ENTITY_QUEUE)

virtual	~cromp_client ()

	DEFINE_CLASS_NAME ("cromp_client")

basis::astring	instance_name () const

const octopi::octopus_entity &	entity () const

void	enable_encryption ()

void	reset (const sockets::internet_address &destination, int connection_wait=DEFAULT_MAX_CONNECT_WAIT, int max_per_ent=DEFAULT_MAX_ENTITY_QUEUE)

basis::outcome	connect (const basis::byte_array &verification=blank_verification())

basis::outcome	asynch_connect ()

bool	connected () const

basis::outcome	disconnect ()

virtual basis::outcome	login ()

basis::outcome	submit (const octopi::infoton &request, octopi::octopus_request_id &item_id, int max_tries=80)

basis::outcome	acquire (octopi::infoton *&response, const octopi::octopus_request_id &cmd_id, int timeout=DEFAULT_MAX_RESPONSE_WAIT)

basis::outcome	synchronous_request (const octopi::infoton &to_send, octopi::infoton *&received, octopi::octopus_request_id &item_id, int timeout=DEFAULT_MAX_RESPONSE_WAIT)

basis::outcome	acquire_any (octopi::infoton *&response, octopi::octopus_request_id &cmd_id, int timeout=DEFAULT_MAX_RESPONSE_WAIT)

octopi::octopus_request_id	next_id ()

void	decrypt_package_as_needed (basis::outcome &to_return, octopi::infoton *&response, const octopi::octopus_request_id &cmd_id)

void	keep_alive_pause (int duration=0, int interval=40)

const basis::byte_array &	verification () const

Public Member Functions inherited from cromp::cromp_common
	cromp_common (const basis::astring &host, int max_per_ent)

	cromp_common (sockets::spocket preexisting, octopi::octopus singleton)

virtual	~cromp_common ()

	DEFINE_CLASS_NAME ("cromp_common")

basis::outcome	open_common (const sockets::internet_address &where)

basis::outcome	close_common ()

sockets::spocket *	spock () const

sockets::internet_address	other_side () const

virtual basis::outcome	add_tentacle (octopi::tentacle *to_add, bool filter=false)

basis::astring	responses_text_form () const

bool	buffer_clog (int clog_point=1 *basis::MEGABYTE) const

basis::outcome	pack_and_ship (const octopi::infoton &request, const octopi::octopus_request_id &item_id, int max_tries)

basis::outcome	pack_and_ship (const octopi::infoton_list &requests, int max_tries)

basis::outcome	retrieve_and_restore (octopi::infoton *&item, const octopi::octopus_request_id &req_id, int timeout)

basis::outcome	retrieve_and_restore_any (octopi::infoton *&item, octopi::octopus_request_id &req_id, int timeout)

basis::outcome	push_outgoing (int max_tries)

void	grab_anything (bool wait)

basis::outcome	send_buffer ()

int	max_bytes_per_entity () const

void	max_bytes_per_entity (int max_bytes_per_entity)

octopi::octopus *	octo () const

int	pending_sends () const
	returns the number of bytes still unsent. More...

int	accumulated_bytes () const
	returns the number of bytes pending processing from the other side. More...

Static Public Member Functions
static const basis::byte_array &	blank_verification ()

Static Public Member Functions inherited from cromp::cromp_common
static int	default_port ()

static const char *	outcome_name (const basis::outcome &to_name)

static basis::astring	chew_hostname (const sockets::internet_address &addr, sockets::internet_address *resolved=NULL_POINTER)

static double	total_bytes_sent ()

static double	total_bytes_received ()

static bool	decode_host (const basis::astring &coded_host, basis::astring &hostname, sockets::machine_uid &machine)

static const crypto::rsa_crypto &	localhost_only_key ()

Friends
class	asynch_connection_thread

Additional Inherited Members
Static Public Attributes inherited from cromp::cromp_common
static const int	HOSTCHOP = 6

Protected Member Functions inherited from cromp::cromp_common
octopi::octopus *	singleton () const

Detailed Description

Definition at line 44 of file cromp_client.h.

Member Enumeration Documentation

◆ constraints

enum cromp::cromp_client::constraints

Enumerator
DEFAULT_MAX_CONNECT_WAIT
DEFAULT_MAX_RESPONSE_WAIT

Definition at line 47 of file cromp_client.h.

Constructor & Destructor Documentation

◆ cromp_client()

cromp::cromp_client::cromp_client	(	const sockets::internet_address &	destination,
		int	connection_wait = `DEFAULT_MAX_CONNECT_WAIT`,
		int	max_per_ent = `DEFAULT_MAX_ENTITY_QUEUE`
	)

Definition at line 125 of file cromp_client.cpp.

References cromp::cromp_common::add_tentacle(), FUNCDEF, LOG, octopi::octopus_entity::mangled_form(), and cromp::cromp_common::open_common().

◆ ~cromp_client()

cromp::cromp_client::~cromp_client ( )

virtual

Definition at line 155 of file cromp_client.cpp.

References cromp::cromp_common::close_common(), disconnect(), FUNCDEF, and basis::WHACK().

Member Function Documentation

◆ acquire()

outcome cromp::cromp_client::acquire	(	octopi::infoton *&	response,
		const octopi::octopus_request_id &	cmd_id,
		int	timeout = `DEFAULT_MAX_RESPONSE_WAIT`
	)

Definition at line 581 of file cromp_client.cpp.

References octopi::unhandled_request::_reason, CHECK_LOCKOUT, decrypt_package_as_needed(), FUNCDEF, LOG, cromp::cromp_common::outcome_name(), and cromp::cromp_common::retrieve_and_restore().

Referenced by synchronous_request().

◆ acquire_any()

outcome cromp::cromp_client::acquire_any	(	octopi::infoton *&	response,
		octopi::octopus_request_id &	cmd_id,
		int	timeout = `DEFAULT_MAX_RESPONSE_WAIT`
	)

Definition at line 601 of file cromp_client.cpp.

References octopi::unhandled_request::_reason, CHECK_LOCKOUT, decrypt_package_as_needed(), FUNCDEF, and cromp::cromp_common::retrieve_and_restore_any().

◆ asynch_connect()

outcome cromp::cromp_client::asynch_connect ( )

Definition at line 408 of file cromp_client.cpp.

References asynch_connection_thread, AUTO_LOCK, connected(), FUNCDEF, instance_name(), LOG, cromp::cromp_common::NO_CONNECTION, NULL_POINTER, and cromp::cromp_common::OKAY.

◆ blank_verification()

const byte_array & cromp::cromp_client::blank_verification ( )

static

Definition at line 287 of file cromp_client.cpp.

◆ connect()

outcome cromp::cromp_client::connect ( const basis::byte_array & verification = blank_verification() )

Definition at line 399 of file cromp_client.cpp.

References AUTO_LOCK, FUNCDEF, and verification().

◆ connected()

bool cromp::cromp_client::connected ( ) const

Definition at line 171 of file cromp_client.cpp.

References sockets::spocket::connected(), and cromp::cromp_common::spock().

Referenced by asynch_connect().

◆ decrypt_package_as_needed()

void cromp::cromp_client::decrypt_package_as_needed	(	basis::outcome &	to_return,
		octopi::infoton *&	response,
		const octopi::octopus_request_id &	cmd_id
	)

Definition at line 622 of file cromp_client.cpp.

References octopi::encryption_tentacle::consume(), cromp::cromp_common::ENCRYPTION_MISMATCH, FUNCDEF, LOG, NULL_POINTER, cromp::cromp_common::octo(), cromp::cromp_common::OKAY, cromp::cromp_common::PARTIAL, octopi::octopus::restore(), octopi::octopus_request_id::text_form(), and basis::WHACK().

Referenced by acquire(), and acquire_any().

◆ DEFINE_CLASS_NAME()

cromp::cromp_client::DEFINE_CLASS_NAME ( "cromp_client" )

◆ disconnect()

outcome cromp::cromp_client::disconnect ( )

Definition at line 476 of file cromp_client.cpp.

References AUTO_LOCK.

Referenced by ~cromp_client().

◆ enable_encryption()

void cromp::cromp_client::enable_encryption ( )

Definition at line 176 of file cromp_client.cpp.

References cromp::cromp_common::add_tentacle(), AUTO_LOCK, FUNCDEF, cromp::cromp_common::localhost_only_key(), LOG, cromp::cromp_common::other_side(), and crypto::rsa_crypto::private_key().

◆ entity()

const octopus_entity & cromp::cromp_client::entity ( ) const

Definition at line 243 of file cromp_client.cpp.

References AUTO_LOCK.

Referenced by instance_name().

◆ instance_name()

basis::astring cromp::cromp_client::instance_name ( ) const

inline

Definition at line 65 of file cromp_client.h.

References entity(), and octopi::octopus_entity::text_form().

Referenced by asynch_connect().

◆ keep_alive_pause()

void cromp::cromp_client::keep_alive_pause	(	int	duration = `0`,
		int	interval = `40`
	)

Definition at line 483 of file cromp_client.cpp.

References cromp::cromp_common::grab_anything(), and cromp::cromp_common::push_outgoing().

◆ login()

outcome cromp::cromp_client::login ( )

virtual

◆ next_id()

octopus_request_id cromp::cromp_client::next_id ( )

Definition at line 261 of file cromp_client.cpp.

References AUTO_LOCK, and structures::roller< contents >::next_id().

Referenced by submit().

◆ reset()

void cromp::cromp_client::reset	(	const sockets::internet_address &	destination,
		int	connection_wait = `DEFAULT_MAX_CONNECT_WAIT`,
		int	max_per_ent = `DEFAULT_MAX_ENTITY_QUEUE`
	)

Definition at line 220 of file cromp_client.cpp.

References AUTO_LOCK, cromp::cromp_common::close_common(), FUNCDEF, LOG, octopi::octopus_entity::mangled_form(), cromp::cromp_common::max_bytes_per_entity(), cromp::cromp_common::open_common(), and structures::roller< contents >::set_current().

◆ submit()

outcome cromp::cromp_client::submit	(	const octopi::infoton &	request,
		octopi::octopus_request_id &	item_id,
		int	max_tries = `80`
	)

Definition at line 542 of file cromp_client.cpp.

References cromp::cromp_common::BAD_INPUT, CHECK_LOCKOUT, FUNCDEF, LOG, next_id(), and cromp::cromp_common::pack_and_ship().

Referenced by synchronous_request().

◆ synchronous_request()

outcome cromp::cromp_client::synchronous_request	(	const octopi::infoton &	to_send,
		octopi::infoton *&	received,
		octopi::octopus_request_id &	item_id,
		int	timeout = `DEFAULT_MAX_RESPONSE_WAIT`
	)

Definition at line 267 of file cromp_client.cpp.

References acquire(), FUNCDEF, LOG, NULL_POINTER, cromp::cromp_common::OKAY, cromp::cromp_common::outcome_name(), submit(), and octopi::infoton::text_form().

Referenced by login().

◆ verification()

const byte_array & cromp::cromp_client::verification ( ) const

Definition at line 173 of file cromp_client.cpp.

Referenced by connect().

Friends And Related Function Documentation

◆ asynch_connection_thread

friend class asynch_connection_thread

friend

Definition at line 175 of file cromp_client.h.

Referenced by asynch_connect().

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

/opt/feistymeow.org/feisty_meow/octopi/library/cromp/cromp_client.h
/opt/feistymeow.org/feisty_meow/octopi/library/cromp/cromp_client.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ constraints

Constructor & Destructor Documentation

◆ cromp_client()

◆ ~cromp_client()

Member Function Documentation

◆ acquire()

◆ acquire_any()

◆ asynch_connect()

◆ blank_verification()

◆ connect()

◆ connected()

◆ decrypt_package_as_needed()

◆ DEFINE_CLASS_NAME()

◆ disconnect()

◆ enable_encryption()

◆ entity()

◆ instance_name()

◆ keep_alive_pause()

◆ login()

◆ next_id()

◆ reset()

◆ submit()

◆ synchronous_request()

◆ verification()

Friends And Related Function Documentation

◆ asynch_connection_thread