AJP API functions
[mod_proxy]

マクロ定義
#define	ajp_msg_append_string(m, v)   ajp_msg_append_string_ex(m, v, 1)
#define	ajp_msg_append_string_ascii(m, v)   ajp_msg_append_string_ex(m, v, 0)
関数
apr_status_t	ajp_msg_check_header (ajp_msg_t *msg, apr_size_t *len)
apr_status_t	ajp_msg_reset (ajp_msg_t *msg)
apr_status_t	ajp_msg_reuse (ajp_msg_t *msg)
apr_status_t	ajp_msg_end (ajp_msg_t *msg)
apr_status_t	ajp_msg_append_uint32 (ajp_msg_t *msg, apr_uint32_t value)
apr_status_t	ajp_msg_append_uint16 (ajp_msg_t *msg, apr_uint16_t value)
apr_status_t	ajp_msg_append_uint8 (ajp_msg_t *msg, apr_byte_t value)
apr_status_t	ajp_msg_append_string_ex (ajp_msg_t *msg, const char *value, int convert)
apr_status_t	ajp_msg_append_bytes (ajp_msg_t *msg, const apr_byte_t *value, apr_size_t valuelen)
apr_status_t	ajp_msg_get_uint32 (ajp_msg_t *msg, apr_uint32_t *rvalue)
apr_status_t	ajp_msg_get_uint16 (ajp_msg_t *msg, apr_uint16_t *rvalue)
apr_status_t	ajp_msg_peek_uint16 (ajp_msg_t *msg, apr_uint16_t *rvalue)
apr_status_t	ajp_msg_get_uint8 (ajp_msg_t *msg, apr_byte_t *rvalue)
apr_status_t	ajp_msg_peek_uint8 (ajp_msg_t *msg, apr_byte_t *rvalue)
apr_status_t	ajp_msg_get_string (ajp_msg_t *msg, const char **rvalue)
apr_status_t	ajp_msg_get_bytes (ajp_msg_t *msg, apr_byte_t **rvalue, apr_size_t *rvalue_len)
apr_status_t	ajp_msg_create (apr_pool_t *pool, apr_size_t size, ajp_msg_t **rmsg)
apr_status_t	ajp_msg_copy (ajp_msg_t *smsg, ajp_msg_t *dmsg)
apr_status_t	ajp_msg_serialize_ping (ajp_msg_t *msg)
apr_status_t	ajp_msg_serialize_cping (ajp_msg_t *msg)
char *	ajp_msg_dump (apr_pool_t *pool, ajp_msg_t *msg, char *err)
apr_status_t	ajp_ilink_send (apr_socket_t *sock, ajp_msg_t *msg)
apr_status_t	ajp_ilink_receive (apr_socket_t *sock, ajp_msg_t *msg)
apr_status_t	ajp_send_header (apr_socket_t *sock, request_rec *r, apr_size_t buffsize, apr_uri_t *uri)
apr_status_t	ajp_read_header (apr_socket_t *sock, request_rec *r, apr_size_t buffsize, ajp_msg_t **msg)
apr_status_t	ajp_alloc_data_msg (apr_pool_t *pool, char **ptr, apr_size_t *len, ajp_msg_t **msg)
apr_status_t	ajp_send_data_msg (apr_socket_t *sock, ajp_msg_t *msg, apr_size_t len)
int	ajp_parse_type (request_rec *r, ajp_msg_t *msg)
apr_status_t	ajp_parse_header (request_rec *r, proxy_dir_conf *conf, ajp_msg_t *msg)
apr_status_t	ajp_parse_data (request_rec *r, ajp_msg_t *msg, apr_uint16_t *len, char **ptr)
apr_status_t	ajp_handle_cping_cpong (apr_socket_t *sock, request_rec *r, apr_interval_time_t timeout)

---

マクロ定義

#define ajp_msg_append_string	(	m,
		v		)	ajp_msg_append_string_ex(m, v, 1)

Add a String in AJP message, and transform the String in ASCII if we're on an EBCDIC machine

#define ajp_msg_append_string_ascii	(	m,
		v		)	ajp_msg_append_string_ex(m, v, 0)

Add a String in AJP message.

---

関数

apr_status_t ajp_alloc_data_msg	(	apr_pool_t *	pool,
		char **	ptr,
		apr_size_t *	len,
		ajp_msg_t **	msg
	)

Allocate a msg to send data

引数:

	pool	pool to allocate from
	ptr	data buffer
	len	the length of allocated data buffer
	msg	returned AJP message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_handle_cping_cpong	(	apr_socket_t *	sock,
		request_rec *	r,
		apr_interval_time_t	timeout
	)

Handle the CPING/CPONG messages

引数:

	sock	backend socket
	r	current request
	timeout	time window for receiving cpong reply

戻り値:

APR_SUCCESS or error

apr_status_t ajp_ilink_receive	(	apr_socket_t *	sock,
		ajp_msg_t *	msg
	)

Receive an AJP message from backend

引数:

	sock	backend socket
	smsg	AJP message to put serialized message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_ilink_send	(	apr_socket_t *	sock,
		ajp_msg_t *	msg
	)

Send an AJP message to backend

引数:

	soct	backend socket
	smsg	AJP message to put serialized message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_append_bytes	(	ajp_msg_t *	msg,
		const apr_byte_t *	value,
		apr_size_t	valuelen
	)

Add a Byte array to AJP Message

引数:

	msg	AJP Message to get value from
	value	Pointer to Byte array
	valuelen	Byte array len

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_append_string_ex	(	ajp_msg_t *	msg,
		const char *	value,
		int	convert
	)

Add a String in AJP message, and transform the String in ASCII if convert is set and we're on an EBCDIC machine

引数:

	msg	AJP Message to get value from
	value	Pointer to String
	convert	When set told to convert String to ASCII

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_append_uint16	(	ajp_msg_t *	msg,
		apr_uint16_t	value
	)

Add an unsigned 16bits value to AJP Message

引数:

	msg	AJP Message to get value from
	value	value to add to AJP Message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_append_uint32	(	ajp_msg_t *	msg,
		apr_uint32_t	value
	)

Add an unsigned 32bits value to AJP Message

引数:

	msg	AJP Message to get value from
	value	value to add to AJP Message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_append_uint8	(	ajp_msg_t *	msg,
		apr_byte_t	value
	)

Add an unsigned 8bits value to AJP Message

引数:

	msg	AJP Message to get value from
	value	value to add to AJP Message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_check_header	(	ajp_msg_t *	msg,
		apr_size_t *	len
	)

Check a new AJP Message by looking at signature and return its size

引数:

	msg	AJP Message to check
	len	Pointer to returned len

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_copy	(	ajp_msg_t *	smsg,
		ajp_msg_t *	dmsg
	)

Recopy an AJP Message to another

引数:

	smsg	source AJP message
	dmsg	destination AJP message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_create	(	apr_pool_t *	pool,
		apr_size_t	size,
		ajp_msg_t **	rmsg
	)

Create an AJP Message from pool

引数:

	pool	memory pool to allocate AJP message from
	size	size of the buffer to create
	rmsg	Pointer to newly created AJP message

戻り値:

APR_SUCCESS or error

char* ajp_msg_dump	(	apr_pool_t *	pool,
		ajp_msg_t *	msg,
		char *	err
	)

Dump up to the first 1024 bytes on an AJP Message

引数:

	pool	pool to allocate from
	msg	AJP Message to dump
	err	error string to display

戻り値:

dump message

apr_status_t ajp_msg_end

(

ajp_msg_t *

msg

)

Mark the end of an AJP Message

引数:

msg

AJP Message to end

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_get_bytes	(	ajp_msg_t *	msg,
		apr_byte_t **	rvalue,
		apr_size_t *	rvalue_len
	)

Get a Byte array from AJP Message

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned
	rvalueLen	Pointer where Byte array len will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_get_string	(	ajp_msg_t *	msg,
		const char **	rvalue
	)

Get a String value from AJP Message

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_get_uint16	(	ajp_msg_t *	msg,
		apr_uint16_t *	rvalue
	)

Get a 16bits unsigned value from AJP Message

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_get_uint32	(	ajp_msg_t *	msg,
		apr_uint32_t *	rvalue
	)

Get a 32bits unsigned value from AJP Message

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_get_uint8	(	ajp_msg_t *	msg,
		apr_byte_t *	rvalue
	)

Get a 8bits unsigned value from AJP Message

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_peek_uint16	(	ajp_msg_t *	msg,
		apr_uint16_t *	rvalue
	)

Peek a 16bits unsigned value from AJP Message, position in message is not updated

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_peek_uint8	(	ajp_msg_t *	msg,
		apr_byte_t *	rvalue
	)

Peek a 8bits unsigned value from AJP Message, position in message is not updated

引数:

	msg	AJP Message to get value from
	rvalue	Pointer where value will be returned

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_reset

(

ajp_msg_t *

msg

)

Reset an AJP Message

引数:

msg

AJP Message to reset

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_reuse

(

ajp_msg_t *

msg

)

Reuse an AJP Message

引数:

msg

AJP Message to reuse

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_serialize_cping

(

ajp_msg_t *

msg

)

Serialize in an AJP Message a CPING command

+-----------------------+ | CPING CMD (1 byte) | +-----------------------+

引数:

smsg

AJP message to put serialized message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_msg_serialize_ping

(

ajp_msg_t *

msg

)

Serialize in an AJP Message a PING command

+-----------------------+ | PING CMD (1 byte) | +-----------------------+

引数:

smsg

AJP message to put serialized message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_parse_data	(	request_rec *	r,
		ajp_msg_t *	msg,
		apr_uint16_t *	len,
		char **	ptr
	)

Parse the message body and return data address and length

引数:

	r	current request
	msg	AJP message
	len	returned AJP message length
	ptr	returned data

戻り値:

APR_SUCCESS or error

apr_status_t ajp_parse_header	(	request_rec *	r,
		proxy_dir_conf *	conf,
		ajp_msg_t *	msg
	)

Parse the header message from container

引数:

	r	current request
	msg	AJP message

戻り値:

APR_SUCCESS or error

int ajp_parse_type	(	request_rec *	r,
		ajp_msg_t *	msg
	)

Parse the message type

引数:

	r	current request
	msg	AJP message

戻り値:

AJP message type.

apr_status_t ajp_read_header	(	apr_socket_t *	sock,
		request_rec *	r,
		apr_size_t	buffsize,
		ajp_msg_t **	msg
	)

Read the ajp message and return the type of the message.

引数:

	sock	backend socket
	r	current request
	buffsize	size of the buffer.
	msg	returned AJP message

戻り値:

APR_SUCCESS or error

apr_status_t ajp_send_data_msg	(	apr_socket_t *	sock,
		ajp_msg_t *	msg,
		apr_size_t	len
	)

Send the data message

引数:

	sock	backend socket
	msg	AJP message to send
	len	AJP message length

戻り値:

APR_SUCCESS or error

apr_status_t ajp_send_header	(	apr_socket_t *	sock,
		request_rec *	r,
		apr_size_t	buffsize,
		apr_uri_t *	uri
	)

Build the ajp header message and send it

引数:

	sock	backend socket
	r	current request
	buffsize	max size of the AJP packet. uri requested uri

戻り値:

APR_SUCCESS or error

---