session.h File Reference

#include <yaz/comstack.h>
#include <yaz/pquery.h>
#include <yaz/ccl.h>
#include <yaz/yaz-ccl.h>
#include "facet_limit.h"
#include "termlists.h"
#include "reclists.h"
#include "http.h"

Go to the source code of this file.

Data Structures
struct	database
struct	session_database
struct	named_termlist
struct	session_watchentry
struct	session
struct	statistics
struct	hitsbytarget

Macros
#define	SESSION_WATCH_SHOW   0
#define	SESSION_WATCH_RECORD   1
#define	SESSION_WATCH_SHOW_PREF   2
#define	SESSION_WATCH_TERMLIST   3
#define	SESSION_WATCH_BYTARGET   4
#define	SESSION_WATCH_MAX   4
#define	SESSION_MAX_TERMLISTS   10

Typedefs
typedef void(*	session_watchfun )(void *data)

Enumerations

enum

pazpar2_error_code {   PAZPAR2_NO_ERROR = 0, PAZPAR2_NO_SESSION, PAZPAR2_MISSING_PARAMETER, PAZPAR2_MALFORMED_PARAMETER_VALUE,   PAZPAR2_MALFORMED_PARAMETER_ENCODING, PAZPAR2_MALFORMED_SETTING, PAZPAR2_HITCOUNTS_FAILED, PAZPAR2_RECORD_MISSING,   PAZPAR2_NO_TARGETS, PAZPAR2_CONFIG_TARGET, PAZPAR2_RECORD_FAIL, PAZPAR2_NOT_IMPLEMENTED,   PAZPAR2_NO_SERVICE, PAZPAR2_ALREADY_BLOCKED, PAZPAR2_LAST_ERROR }

Functions
struct hitsbytarget *	get_hitsbytarget (struct session *s, int *count, NMEM nmem)
struct session *	new_session (NMEM nmem, struct conf_service *service, unsigned session_id)
void	session_destroy (struct session *s)
void	session_init_databases (struct session *s)
void	statistics (struct session *s, struct statistics *stat)
void	session_sort (struct session *se, struct reclist_sortparms *sp)
enum pazpar2_error_code	session_search (struct session *s, const char *query, const char *startrecs, const char *maxrecs, const char *filter, const char *limit, const char **addinfo, struct reclist_sortparms *sort_parm)
struct record_cluster **	show_range_start (struct session *s, struct reclist_sortparms *sp, int start, int *num, int *total, Odr_int *sumhits, Odr_int *approximation, void(*ready)(void *data), struct http_channel *chan)
int	session_fetch_more (struct session *s)
void	show_range_stop (struct session *s, struct record_cluster **recs)
struct record_cluster *	show_single_start (struct session *s, const char *id, struct record_cluster **prev_r, struct record_cluster **next_r)
void	show_single_stop (struct session *s, struct record_cluster *rec)
int	session_set_watch (struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c)
int	session_active_clients (struct session *s)
int	session_is_preferred_clients_ready (struct session *s)
void	session_apply_setting (struct session *se, char *dbname, char *setting, char *value)
const char *	session_setting_oneval (struct session_database *db, int offset)
int	ingest_record (struct client *cl, const char *rec, int record_no, NMEM nmem)
	ingest XML record
void	session_alert_watch (struct session *s, int what)
void	add_facet (struct session *s, const char *type, const char *value, int count)
int	session_check_cluster_limit (struct session *se, struct record_cluster *rec)
void	perform_termlist (struct http_channel *c, struct session *se, const char *name, int num, int version)
void	session_log (struct session *s, int level, const char *fmt,...)

Macro Definition Documentation

#define SESSION_MAX_TERMLISTS   10

Definition at line 84 of file session.h.

Referenced by add_facet().

#define SESSION_WATCH_BYTARGET   4

Definition at line 81 of file session.h.

Referenced by client_got_records(), client_set_state(), and cmd_bytarget().

#define SESSION_WATCH_MAX   4

Definition at line 82 of file session.h.

Referenced by new_session().

#define SESSION_WATCH_RECORD   1

Definition at line 78 of file session.h.

Referenced by client_got_records(), and show_record().

#define SESSION_WATCH_SHOW   0

Definition at line 77 of file session.h.

Referenced by client_got_records(), client_set_state(), cmd_show(), and show_range_start().

#define SESSION_WATCH_SHOW_PREF   2

Definition at line 79 of file session.h.

Referenced by client_check_preferred_watch(), client_set_state(), and cmd_show().

#define SESSION_WATCH_TERMLIST   3

Definition at line 80 of file session.h.

Referenced by client_got_records(), client_set_state(), and cmd_termlist().

Typedef Documentation

typedef void(* session_watchfun)(void *data)

Definition at line 86 of file session.h.

Enumeration Type Documentation

enum pazpar2_error_code

Enumerator:

PAZPAR2_NO_ERROR
PAZPAR2_NO_SESSION
PAZPAR2_MISSING_PARAMETER
PAZPAR2_MALFORMED_PARAMETER_VALUE
PAZPAR2_MALFORMED_PARAMETER_ENCODING
PAZPAR2_MALFORMED_SETTING
PAZPAR2_HITCOUNTS_FAILED
PAZPAR2_RECORD_MISSING
PAZPAR2_NO_TARGETS
PAZPAR2_CONFIG_TARGET
PAZPAR2_RECORD_FAIL
PAZPAR2_NOT_IMPLEMENTED
PAZPAR2_NO_SERVICE
PAZPAR2_ALREADY_BLOCKED
PAZPAR2_LAST_ERROR

Definition at line 37 of file session.h.

Function Documentation

void add_facet	(	struct session *	s,
		const char *	type,
		const char *	value,
		int	count
	)

Definition at line 212 of file session.c.

References named_termlist::name, session::nmem, session::num_termlists, session_log(), SESSION_MAX_TERMLISTS, session_normalize_facet(), named_termlist::termlist, termlist_create(), termlist_insert(), and session::termlists.

Referenced by client_report_facets(), and ingest_to_cluster().

struct hitsbytarget* get_hitsbytarget ( struct session *  s, int *  count, NMEM  nmem  )

read

Definition at line 1032 of file session.c.

References hitsbytarget_nb(), session_enter(), and session_leave().

Referenced by bytarget_response().

int ingest_record	(	struct client *	cl,
		const char *	rec,
		int	record_no,
		NMEM	nmem
	)

ingest XML record

Parameters

cl	client holds the result set for record
rec	record buffer (0 terminated)
record_no	record position (1, 2, ..)
nmem	working NMEM

Return values

0	OK
-1	failure
-2	Filtered

Definition at line 1647 of file session.c.

References check_record_filter(), client_get_database(), client_get_session(), session_database::database, get_mergekey(), database::id, ingest_to_cluster(), normalize_record(), session::relevance, session::service, session_enter(), session_leave(), and session_log().

Referenced by client_record_ingest().

struct session* new_session ( NMEM  nmem, struct conf_service *  service, unsigned  session_id  )

read

Definition at line 949 of file session.c.

References session::clients_active, session::clients_cached, session_watchentry::data, session::databases, session::facet_limits, session_watchentry::fun, session::nmem, session::normalize_cache, normalize_cache_create(), session::num_termlists, session::number_of_warnings_unknown_elements, session::number_of_warnings_unknown_metadata, pazpar2_mutex_create(), session::reclist, reclist_create(), session::relevance, session::service, session::session_id, session_log(), session::session_mutex, session::session_nmem, session_use(), SESSION_WATCH_MAX, session::settings_modified, session::sorted_results, session::total_records, and session::watchlist.

Referenced by http_session_create().

void perform_termlist	(	struct http_channel *	c,
		struct session *	se,
		const char *	name,
		int	num,
		int	version
	)

Definition at line 1107 of file session.c.

References termlist_score::display_term, termlist_score::frequency, named_termlist::name, http_channel::nmem, session::num_termlists, session_enter(), session_leave(), targets_termlist_nb(), named_termlist::termlist, termlist_highscore(), session::termlists, and http_channel::wrbuf.

Referenced by termlist_response().

int session_active_clients

(

struct session *

s

)

Definition at line 600 of file session.c.

References client_list::client, client_is_active(), session::clients_active, and client_list::next.

Referenced by client_set_state(), cmd_bytarget(), cmd_show(), cmd_stat(), cmd_termlist(), show_record(), show_records(), and termlist_response().

void session_alert_watch	(	struct session *	s,
		int	what
	)

Definition at line 484 of file session.c.

References session_watchentry::data, session_watchentry::fun, fun, http_remove_observer(), session_watchentry::obs, session_enter(), session_leave(), session_log(), and session::watchlist.

Referenced by client_check_preferred_watch(), client_got_records(), and client_set_state().

void session_apply_setting	(	struct session *	se,
		char *	dbname,
		char *	setting,
		char *	value
	)

Definition at line 884 of file session.c.

References expand_settings_array(), find_session_database(), session_database::map, session_database::num_settings, PZ_XSLT, session::service, session::session_nmem, session_database::settings, settings_create_offset(), session::settings_modified, and setting::value.

Referenced by apply_local_setting(), and process_settings().

int session_check_cluster_limit	(	struct session *	se,
		struct record_cluster *	rec
	)

Definition at line 1726 of file session.c.

References conf_service_metadata_field_id(), session::facet_limits, facet_limits_get(), conf_metadata::limitcluster, match_metadata_local(), record_cluster::metadata, conf_service::metadata, conf_metadata::name, name, conf_service::num_metadata, and session::service.

Referenced by reclist_limit().

void session_destroy

(

struct session *

s

)

Definition at line 916 of file session.c.

References session::databases, session::facet_limits, facet_limits_destroy(), session_database::next, session::nmem, session::normalize_cache, normalize_cache_destroy(), session::reclist, reclist_destroy(), session::relevance, relevance_destroy(), session::service, service_destroy(), session_database_destroy(), session_log(), session::session_mutex, session::session_nmem, session_remove_cached_clients(), and session_use().

Referenced by http_session_destroy(), and http_sessions_destroy().

int session_fetch_more

(

struct session *

s

)

Definition at line 1233 of file session.c.

References client_list::client, client_fetch_more(), client_get_id(), client_get_state(), client_get_state_str(), Client_Idle, session::clients_active, client_list::next, and session_log().

Referenced by show_range_start().

void session_init_databases

(

struct session *

s

)

Definition at line 853 of file session.c.

References session::databases, predef_grep_databases(), session::service, and session_init_databases_fun().

Referenced by cmd_init().

int session_is_preferred_clients_ready

(

struct session *

s

)

Definition at line 612 of file session.c.

References client_list::client, client_is_active_preferred(), session::clients_active, client_list::next, and session_log().

Referenced by client_check_preferred_watch(), and cmd_show().

void session_log	(	struct session *	s,
		int	level,
		const char *	fmt,
			...
	)

Definition at line 2149 of file session.c.

References session::session_id.

Referenced by add_facet(), bytarget_response(), bytarget_result_ready(), client_parse_query(), client_record_ingest(), client_start_search(), cmd_bytarget(), cmd_init(), cmd_record_ready(), cmd_show(), cmd_termlist(), http_session_create(), http_session_destroy(), ingest_record(), ingest_to_cluster(), new_session(), normalize_record(), prepare_map(), record_to_xml(), session_alert_watch(), session_clear_set(), session_destroy(), session_enter(), session_fetch_more(), session_is_preferred_clients_ready(), session_leave(), session_normalize_facet(), session_search(), session_sort_unlocked(), show_range_start(), show_records_ready(), and termlist_result_ready().

enum pazpar2_error_code session_search	(	struct session *	s,
		const char *	query,
		const char *	startrecs,
		const char *	maxrecs,
		const char *	filter,
		const char *	limit,
		const char **	addinfo,
		struct reclist_sortparms *	sort_parm
	)

Definition at line 727 of file session.c.

References client_list::client, client_get_database(), client_parse_init(), client_parse_query(), client_parse_range(), client_parse_sort(), client_start_search(), session::clients_active, session::facet_limits, facet_limits_create(), facet_limits_destroy(), client_list::next, PAZPAR2_MALFORMED_PARAMETER_VALUE, PAZPAR2_NO_ERROR, PAZPAR2_NO_TARGETS, prepare_map(), session::relevance, relevance_destroy(), select_targets(), session_clear_set(), session_enter(), session_leave(), session_log(), session_remove_cached_clients(), session_reset_active_clients(), and session::settings_modified.

Referenced by cmd_search().

int session_set_watch	(	struct session *	s,
		int	what,
		session_watchfun	fun,
		void *	data,
		struct http_channel *	c
	)

Definition at line 463 of file session.c.

References session_watchentry::data, session_watchentry::fun, fun, http_add_observer(), session_watchentry::obs, session_enter(), session_leave(), session_watch_cancel(), and session::watchlist.

Referenced by cmd_bytarget(), cmd_show(), cmd_termlist(), show_range_start(), and show_record().

const char* session_setting_oneval	(	struct session_database *	db,
		int	offset
	)

Definition at line 396 of file session.c.

References session_database::num_settings, session_database::settings, and setting::value.

Referenced by check_record_filter(), client_fetch_more(), client_parse_query(), client_prep_connection(), client_record_ingest(), client_send_raw_present(), client_show_raw_begin(), client_start_search(), connection_connect(), hitsbytarget_nb(), ingest_to_cluster(), insert_settings_parameters(), insert_settings_values(), prepare_map(), and write_subrecord().

void session_sort	(	struct session *	se,
		struct reclist_sortparms *	sp
	)

Definition at line 720 of file session.c.

References session_sort_unlocked().

Referenced by cmd_show().

struct record_cluster** show_range_start ( struct session *  s, struct reclist_sortparms *  sp, int  start, int *  num, int *  total, Odr_int *  sumhits, Odr_int *  approximation, void(*)(void *data)  ready, struct http_channel *  chan  )

read

Definition at line 1265 of file session.c.

References record::client, client_list::client, client_get_approximation(), client_get_hits(), client_update_show_stat(), session::clients_active, Metadata_sortkey_relevance, reclist_sortparms::next, record::next, client_list::next, session::nmem, session::reclist, reclist_enter(), reclist_get_num_records(), reclist_leave(), reclist_limit(), reclist_read_record(), reclist_sort(), record_cluster::records, session::relevance, relevance_prepare_read(), session_enter(), session_fetch_more(), session_log(), session_set_watch(), SESSION_WATCH_SHOW, show_range_stop(), show_records_ready(), and reclist_sortparms::type.

Referenced by show_records().

void show_range_stop	(	struct session *	s,
		struct record_cluster **	recs
	)

Definition at line 1367 of file session.c.

References session_leave().

Referenced by show_range_start(), and show_records().

struct record_cluster* show_single_start ( struct session *  s, const char *  id, struct record_cluster **  prev_r, struct record_cluster **  next_r  )

read

Definition at line 1200 of file session.c.

References record_cluster::recid, session::reclist, reclist_enter(), reclist_leave(), reclist_limit(), reclist_read_record(), session_enter(), and session_leave().

Referenced by show_record().

void show_single_stop	(	struct session *	s,
		struct record_cluster *	rec
	)

Definition at line 1227 of file session.c.

References session_leave().

Referenced by show_record().

void statistics	(	struct session *	s,
		struct statistics *	stat
	)

Definition at line 1372 of file session.c.

References client_list::client, Client_Connecting, Client_Error, Client_Failed, client_get_connection(), client_get_hits(), client_get_state(), Client_Idle, Client_Working, session::clients_active, client_list::next, statistics::num_clients, statistics::num_connecting, statistics::num_error, statistics::num_failed, statistics::num_hits, statistics::num_idle, statistics::num_no_connection, statistics::num_records, statistics::num_working, and session::total_records.

Referenced by cmd_stat().