cddb_conn_s Struct Reference

An opaque structure for keeping state about the connection to a CDDB server. More...

#include <cddb_conn.h>

List of all members.

Public Attributes
unsigned int	buf_size
	maximum line/buffer size, defaults to 1024 (see DEFAULT_BUF_SIZE)
char *	line
	last line read
int	is_connected
	are we already connected to the server?
sockaddr_in	sa
	the socket address structure for connecting to the CDDB server
int	socket
	the socket file descriptor
char *	server_name
	host name of the CDDB server, defaults to 'freedb.org' (see DEFAULT_SERVER)
int	server_port
	port of the CDDB server, defaults to 888 (see DEFAULT_PORT)
int	timeout
	time out interval (in seconds) used during network operations, defaults to 10 seconds (see DEFAULT_TIMEOUT)
char *	http_path_query
	URL for querying the server through HTTP, defaults to /~cddb/cddb.cgi' (see DEFAULT_PATH_QUERY).
char *	http_path_submit
	URL for submitting to the server through HTTP, defaults to /~cddb/submit.cgi' (see DEFAULT_PATH_SUBMIT).
int	is_http_enabled
	use HTTP, disabled by default
int	is_http_proxy_enabled
	use HTTP through a proxy server, disabled by default
char *	http_proxy_server
	host name of the HTTP proxy server
int	http_proxy_server_port
	port of the HTTP proxy server, defaults to 8080 (see DEFAULT_PROXY_PORT)
char *	http_proxy_username
	HTTP proxy user name.
char *	http_proxy_password
	HTTP proxy password.
char *	http_proxy_auth
	Base64 encoded username:password.
FILE *	cache_fp
	a file pointer to a cached CDDB entry or NULL if no cached version is available
int	use_cache
	field to specify local CDDB cache behaviour, enabled by default (CACHE_ON)
char *	cache_dir
	CDDB slave cache, defaults to '~/.cddbslave' (see DEFAULT_CACHE).
int	cache_read
	read data from cached file instead of from the network
char *	cname
	name of the client program, 'libcddb' by default
char *	cversion
	version of the client program, current libcddb version by default
char *	user
	user name supplied to CDDB server, defaults to the value of the 'USER' environment variable or 'anonymous' if undefined
char *	hostname
	host name of the local machine, defaults to the value of the 'HOSTNAME' environment variable or 'localhost' if undefined
cddb_error_t	errnum
	error number of last CDDB command
list_t *	query_data
	list to keep CDDB query results
list_t *	sites_data
	list to keep FreeDB mirror sites
cddb_iconv_t	charset
	character set conversion settings

---

Detailed Description

An opaque structure for keeping state about the connection to a CDDB server.

---

Member Data Documentation

unsigned int cddb_conn_s::buf_size

maximum line/buffer size, defaults to 1024 (see DEFAULT_BUF_SIZE)

char* cddb_conn_s::cache_dir

CDDB slave cache, defaults to '~/.cddbslave' (see DEFAULT_CACHE).

FILE* cddb_conn_s::cache_fp

a file pointer to a cached CDDB entry or NULL if no cached version is available

int cddb_conn_s::cache_read

read data from cached file instead of from the network

cddb_iconv_t cddb_conn_s::charset

character set conversion settings

char* cddb_conn_s::cname

name of the client program, 'libcddb' by default

char* cddb_conn_s::cversion

version of the client program, current libcddb version by default

cddb_error_t cddb_conn_s::errnum

error number of last CDDB command

char* cddb_conn_s::hostname

host name of the local machine, defaults to the value of the 'HOSTNAME' environment variable or 'localhost' if undefined

char* cddb_conn_s::http_path_query

URL for querying the server through HTTP, defaults to /~cddb/cddb.cgi' (see DEFAULT_PATH_QUERY).

char* cddb_conn_s::http_path_submit

URL for submitting to the server through HTTP, defaults to /~cddb/submit.cgi' (see DEFAULT_PATH_SUBMIT).

char* cddb_conn_s::http_proxy_auth

Base64 encoded username:password.

char* cddb_conn_s::http_proxy_password

HTTP proxy password.

char* cddb_conn_s::http_proxy_server

host name of the HTTP proxy server

int cddb_conn_s::http_proxy_server_port

port of the HTTP proxy server, defaults to 8080 (see DEFAULT_PROXY_PORT)

char* cddb_conn_s::http_proxy_username

HTTP proxy user name.

int cddb_conn_s::is_connected

are we already connected to the server?

int cddb_conn_s::is_http_enabled

use HTTP, disabled by default

int cddb_conn_s::is_http_proxy_enabled

use HTTP through a proxy server, disabled by default

char* cddb_conn_s::line

last line read

list_t* cddb_conn_s::query_data

list to keep CDDB query results

struct sockaddr_in cddb_conn_s::sa

the socket address structure for connecting to the CDDB server

char* cddb_conn_s::server_name

host name of the CDDB server, defaults to 'freedb.org' (see DEFAULT_SERVER)

int cddb_conn_s::server_port

port of the CDDB server, defaults to 888 (see DEFAULT_PORT)

list_t* cddb_conn_s::sites_data

list to keep FreeDB mirror sites

int cddb_conn_s::socket

the socket file descriptor

int cddb_conn_s::timeout

time out interval (in seconds) used during network operations, defaults to 10 seconds (see DEFAULT_TIMEOUT)

int cddb_conn_s::use_cache

field to specify local CDDB cache behaviour, enabled by default (CACHE_ON)

char* cddb_conn_s::user

user name supplied to CDDB server, defaults to the value of the 'USER' environment variable or 'anonymous' if undefined

---

The documentation for this struct was generated from the following file:

• cddb_conn.h

---