ws Namespace Reference

The ws namespace contains the class framework for building WSPR services that handle HTTP requests. More...

Namespaces
namespace	detail
Classes
struct	ActionConfig
struct	EventQueueInitializer
class	EventQueue
struct	WebServiceCall
struct	WebServiceProtocol
struct	WebServiceCallContextOneWay
struct	WebServiceCallContextTwoWay
class	WebService
struct	CallParameter
struct	PatternParameter
struct	WebServiceModuleContext
	WebServiceModuleContext stores information about the initialization and execution context of a WebServiceModule so that the WebServiceModule may configure itself and reuse resources from the containing execution environment. More...
struct	WebServiceModule
class	DefaultWebServiceModule
struct	WebServiceRunnerInitializer
struct	WebServiceModuleConfig
class	WebServiceRunner
Typedefs
typedef WSPR_DEFINE_NAMESPACE(fcgi) Properties *	get_event (const properties_ptr &template_data, const unsigned int i=0)
typedef boost::function< void(const WebServiceCall &, const NS_SSRC_WISP_PROTOCOL::MessageInfo &)>	call_handler_type
typedef std::unordered_map < string, call_handler_type >	call_handler_map
typedef boost::ptr_vector < CallParameter >	parameter_sequence
typedef boost::shared_ptr < WebServiceModuleContext >	ws_module_context_ptr
Functions
template<typename container_type >
void	get_actions (container_type &result, const Properties &action_map)
WebServiceProtocol::CallTwoWay::return_type	call_two_way (WebServiceProtocol::caller_type &call, const string &dest, const string &ws_call, const session_ptr &session, WSPR_DEFINE_NAMESPACE(fcgi)::parameter_map &&parameters)
template<typename... P>
WebServiceProtocol::CallTwoWay::return_type	call_two_way (WebServiceProtocol::caller_type &call, const string &dest, const string &ws_call, const session_ptr &session, P &&...p)
Properties &	set_web_event_header (Properties &properties, const string &protocol, const string &call)
Properties &	set_web_event_header (Properties &properties, const string &protocol, const string &call, const gsid_type gsid)
properties_unique_ptr	web_event (const string &protocol, const string &call)
properties_unique_ptr	web_event (const string &protocol, const string &call, const gsid_type gsid)
Properties &	web_event_indirect (Properties &properties, const string &protocol, const string &call)
Properties &	web_event_indirect (Properties &properties, const string &protocol, const string &call, const gsid_type gsid)
Properties &	web_event_direct (Properties &properties, const string &protocol, const string &call)
Properties &	web_event_direct (Properties &properties, const string &protocol, const string &call, const gsid_type gsid)
template<typename ws_type , typename param_type >
void	ws_call (ws_type *impl, void(ws_type::*call_handler)(const WebServiceCall &, const param_type &, const MessageInfo &), const WebServiceCall &call, const MessageInfo &msginfo)
void	validate_call (const ActionConfig &action, const call_handler_type &call_handler, const WebServiceCall &wc, const MessageInfo &msginfo) SSRC_DECL_THROW(std
template<typename container_type >
void	get_ws_module_configs (container_type &result, const Properties &modules)

---

Detailed Description

The ws namespace contains the class framework for building WSPR services that handle HTTP requests.

---

Typedef Documentation

typedef std::unordered_map<string, call_handler_type> ws::call_handler_map

Definition at line 36 of file ws/types.h.

typedef boost::function<void (const WebServiceCall &, const NS_SSRC_WISP_PROTOCOL::MessageInfo &)> ws::call_handler_type

Definition at line 34 of file ws/types.h.

typedef WSPR_DEFINE_NAMESPACE (fcgi) Properties* ws::get_event(const properties_ptr &template_data, const unsigned int i=0)

Definition at line 33 of file call_util.h.

typedef boost::ptr_vector<CallParameter> ws::parameter_sequence

Definition at line 93 of file ws/types.h.

typedef boost::shared_ptr<WebServiceModuleContext> ws::ws_module_context_ptr

Definition at line 78 of file WebServiceModule.h.

---

Function Documentation

WebServiceProtocol::CallTwoWay::return_type ws::call_two_way	(	WebServiceProtocol::caller_type &	call,
		const string &	dest,
		const string &	ws_call,
		const session_ptr &	session,
		WSPR_DEFINE_NAMESPACE(fcgi)::parameter_map &&	parameters
	)		[inline]

Definition at line 40 of file call_util.h.

Referenced by call_two_way().

template<typename... P>

WebServiceProtocol::CallTwoWay::return_type ws::call_two_way	(	WebServiceProtocol::caller_type &	call,
		const string &	dest,
		const string &	ws_call,
		const session_ptr &	session,
		P &&...	p
	)		[inline]

Definition at line 52 of file call_util.h.

References call_two_way(), and utility::emplace().

template<typename container_type >

void ws::get_actions	(	container_type &	result,
		const Properties &	action_map
	)

Definition at line 142 of file ActionConfig.h.

Referenced by ws::WebServiceRunner::WebServiceRunner().

template<typename container_type >

void ws::get_ws_module_configs	(	container_type &	result,
		const Properties &	modules
	)

Definition at line 115 of file WebServiceRunner.h.

Referenced by ws::WebServiceRunner::WebServiceRunner().

Properties& ws::set_web_event_header	(	Properties &	properties,
		const string &	protocol,
		const string &	call
	)		[inline]

Definition at line 58 of file ws/protocol.h.

Referenced by set_web_event_header(), web_event(), web_event_direct(), and web_event_indirect().

Properties& ws::set_web_event_header	(	Properties &	properties,
		const string &	protocol,
		const string &	call,
		const gsid_type	gsid
	)		[inline]

Definition at line 67 of file ws/protocol.h.

References set_web_event_header().

void ws::validate_call	(	const ActionConfig &	action,
		const call_handler_type &	call_handler,
		const WebServiceCall &	wc,
		const MessageInfo &	msginfo
	)

Definition at line 21 of file ws/service.cc.

Referenced by ws::WebService::set_action_handler().

properties_unique_ptr ws::web_event	(	const string &	protocol,
		const string &	call
	)		[inline]

Definition at line 77 of file ws/protocol.h.

References set_web_event_header().

Referenced by ws::EventQueue::process_request().

properties_unique_ptr ws::web_event	(	const string &	protocol,
		const string &	call,
		const gsid_type	gsid
	)		[inline]

Definition at line 84 of file ws/protocol.h.

References set_web_event_header().

Properties& ws::web_event_direct	(	Properties &	properties,
		const string &	protocol,
		const string &	call
	)		[inline]

Definition at line 105 of file ws/protocol.h.

References set_web_event_header().

Referenced by ws::EventQueue::fetch().

Properties& ws::web_event_direct	(	Properties &	properties,
		const string &	protocol,
		const string &	call,
		const gsid_type	gsid
	)		[inline]

Definition at line 115 of file ws/protocol.h.

References set_web_event_header().

Properties& ws::web_event_indirect	(	Properties &	properties,
		const string &	protocol,
		const string &	call
	)		[inline]

Definition at line 90 of file ws/protocol.h.

References set_web_event_header().

Referenced by group_session::process_find_group_sessions_result(), and group_session::GroupSessionService::process_request().

Properties& ws::web_event_indirect	(	Properties &	properties,
		const string &	protocol,
		const string &	call,
		const gsid_type	gsid
	)		[inline]

Definition at line 97 of file ws/protocol.h.

References set_web_event_header().

template<typename ws_type , typename param_type >

void ws::ws_call	(	ws_type *	impl,
		void(ws_type::*)(const WebServiceCall &, const param_type &, const MessageInfo &)	call_handler,
		const WebServiceCall &	call,
		const MessageInfo &	msginfo
	)		[inline]

Definition at line 245 of file ws/protocol.h.

References ws::WebServiceCall::call, and ws::WebServiceCall::parameters.