sofia-sip/nth.h File Reference

---

Detailed Description

Transaction API for HTTP.

Author:

Pekka Pessi <Pekka.Pessi@nokia-email.address.hidden>.

Date:

Created: Wed Jun 5 19:25:18 2002 ppessi

#include <sofia-sip/su_wait.h>
#include <sofia-sip/su_tag.h>
#include <sofia-sip/http.h>
#include <sofia-sip/http_status.h>
#include <sofia-sip/nth_tag.h>

Include dependency graph for nth.h:

Go to the source code of this file.

Defines
#define	NTH_CLIENT_MAGIC_T
	Default type of application context for client NTH requests.
#define	NTH_SITE_MAGIC_T
	Default type of application context for NTH servers.
#define	NTH_VERSION
	Version number.
Typedefs
typedef nth_engine_s	nth_engine_t
	NTH engine.
typedef nth_client_s	nth_client_t
	NTH client request.
typedef nth_site_s	nth_site_t
	NTH (virtual) hosts or site(s).
typedef nth_request_s	nth_request_t
	Server transaction.
typedef NTH_CLIENT_MAGIC_T	nth_client_magic_t
	Application context for client requests.
typedef NTH_SITE_MAGIC_T	nth_site_magic_t
	Application context for NTH servers.
Functions
msg_t *	nth_engine_msg_create (nth_engine_t *he, int flags)
	Create a new message.
int	nth_client_status (nth_client_t const *clnt)
	Gets client status.
http_method_t	nth_client_method (nth_client_t const *cnlt)
	Gets client method.
int	nth_client_is_streaming (nth_client_t const *hc)
	Is client streaming response?
url_t const *	nth_client_url (nth_client_t const *clnt)
	Get original Request-URI.
msg_t *	nth_client_request (nth_client_t *clnt)
	Get request message.
msg_t *	nth_client_response (nth_client_t const *clnt)
	Get response message.
void	nth_client_destroy (nth_client_t *clnt)
	Destroy client request.
nth_site_t *	nth_site_create (nth_site_t *parent, nth_request_f *req_callback, nth_site_magic_t *magic, url_string_t const *address, tag_type_t tag, tag_value_t value,...)
	Create a http site object.

---

Define Documentation

#define NTH_CLIENT_MAGIC_T

Default type of application context for client NTH requests.

Application may define this to appropriate type before including <nth.h>.

#define NTH_SITE_MAGIC_T

Default type of application context for NTH servers.

Application may define this to appropriate type before including <nth.h>.

---

Function Documentation

http_method_t nth_client_method

(

nth_client_t const *

hc

)

Gets client method.

Parameters:

hc

pointer to a nth client object

Returns:

Returns the HTTP method from the request. If hc is NULL, returns http_method_invalid.

int nth_client_status

(

nth_client_t const *

hc

)

Gets client status.

Parameters:

hc

pointer to a nth client object

Returns:

Returns the status code from the response message if it has been received. A status code below 100 indicates that no response has been received. If request timeouts, the connection is closed and the status code is set to 408. If hc is NULL, returns 400 (Bad Request).

nth_site_t* nth_site_create	(	nth_site_t *	parent,
		nth_request_f *	callback,
		nth_site_magic_t *	magic,
		url_string_t const *	address,
		tag_type_t	tag,
		tag_value_t	value,
			...
	)

Create a http site object.

The function nth_site_create() allocates and initializes a web site object. A web site object can be either a primary http server, a virtual http server or a site within a server

---

Sofia-SIP 1.12.1 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.