Collaboration diagram for AJP API functions:

Macros
#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)

Functions
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)

apr_status_t	ajp_msg_dump (apr_pool_t pool, ajp_msg_t msg, char err, apr_size_t count, char *buf)

apr_status_t	ajp_msg_log (request_rec r, 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, const char secret)

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_parse_reuse (request_rec r, ajp_msg_t msg, apr_byte_t *reuse)

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

const char *	ajp_type_str (int type)

Detailed Description

Macro Definition Documentation

◆ ajp_msg_append_string

#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

◆ ajp_msg_append_string_ascii

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

Add a String in AJP message.

Function Documentation

◆ ajp_alloc_data_msg()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_handle_cping_cpong()

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

Handle the CPING/CPONG messages

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_ilink_receive()

apr_status_t ajp_ilink_receive	(	apr_socket_t *	sock,
		ajp_msg_t *	msg
	)

Receive an AJP message from backend

Parameters

sock	backend socket
msg	AJP message to put serialized message

Returns: APR_SUCCESS or error

◆ ajp_ilink_send()

apr_status_t ajp_ilink_send	(	apr_socket_t *	sock,
		ajp_msg_t *	msg
	)

Send an AJP message to backend

Parameters

sock	backend socket
msg	AJP message to put serialized message

Returns: APR_SUCCESS or error

◆ ajp_msg_append_bytes()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_append_string_ex()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_append_uint16()

apr_status_t ajp_msg_append_uint16	(	ajp_msg_t *	msg,
		apr_uint16_t	value
	)

Add an unsigned 16bits value to AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_append_uint32()

apr_status_t ajp_msg_append_uint32	(	ajp_msg_t *	msg,
		apr_uint32_t	value
	)

Add an unsigned 32bits value to AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_append_uint8()

apr_status_t ajp_msg_append_uint8	(	ajp_msg_t *	msg,
		apr_byte_t	value
	)

Add an unsigned 8bits value to AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_check_header()

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

Parameters

msg	AJP Message to check
len	Pointer to returned len

Returns: APR_SUCCESS or error

◆ ajp_msg_copy()

apr_status_t ajp_msg_copy	(	ajp_msg_t *	smsg,
		ajp_msg_t *	dmsg
	)

Recopy an AJP Message to another

Parameters

smsg	source AJP message
dmsg	destination AJP message

Returns: APR_SUCCESS or error

◆ ajp_msg_create()

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

Create an AJP Message from pool

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_dump()

apr_status_t ajp_msg_dump	(	apr_pool_t *	pool,
		ajp_msg_t *	msg,
		char *	err,
		apr_size_t	count,
		char **	buf
	)

Dump up to the first 1024 bytes on an AJP Message

Parameters

pool	pool to allocate from
msg	AJP Message to dump
err	error string to display
count	the number of bytes to dump
buf	buffer pointer for dump message

Returns: APR_SUCCESS or error

◆ ajp_msg_end()

apr_status_t ajp_msg_end ( ajp_msg_t * msg )

Mark the end of an AJP Message

Parameters

msg	AJP Message to end

Returns: APR_SUCCESS or error

◆ ajp_msg_get_bytes()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_get_string()

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

Get a String value from AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_get_uint16()

apr_status_t ajp_msg_get_uint16	(	ajp_msg_t *	msg,
		apr_uint16_t *	rvalue
	)

Get a 16bits unsigned value from AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_get_uint32()

apr_status_t ajp_msg_get_uint32	(	ajp_msg_t *	msg,
		apr_uint32_t *	rvalue
	)

Get a 32bits unsigned value from AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_get_uint8()

apr_status_t ajp_msg_get_uint8	(	ajp_msg_t *	msg,
		apr_byte_t *	rvalue
	)

Get a 8bits unsigned value from AJP Message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_log()

apr_status_t ajp_msg_log	(	request_rec *	r,
		ajp_msg_t *	msg,
		char *	err
	)

Log an AJP message

Parameters

r	The current request
msg	AJP Message to dump
err	error string to display

Returns: APR_SUCCESS or error

◆ ajp_msg_peek_uint16()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_peek_uint8()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_msg_reset()

apr_status_t ajp_msg_reset ( ajp_msg_t * msg )

Reset an AJP Message

Parameters

msg	AJP Message to reset

Returns: APR_SUCCESS or error

◆ ajp_msg_reuse()

apr_status_t ajp_msg_reuse ( ajp_msg_t * msg )

Reuse an AJP Message

Parameters

msg	AJP Message to reuse

Returns: APR_SUCCESS or error

◆ ajp_msg_serialize_cping()

apr_status_t ajp_msg_serialize_cping ( ajp_msg_t * msg )

Serialize in an AJP Message a CPING command

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

Parameters

msg	AJP message to put serialized message

Returns: APR_SUCCESS or error

◆ ajp_msg_serialize_ping()

apr_status_t ajp_msg_serialize_ping ( ajp_msg_t * msg )

Serialize in an AJP Message a PING command

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

Parameters

msg	AJP message to put serialized message

Returns: APR_SUCCESS or error

◆ ajp_parse_data()

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

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_parse_header()

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

Parse the header message from container

Parameters

r	current request
conf	proxy config
msg	AJP message

Returns: APR_SUCCESS or error

◆ ajp_parse_reuse()

apr_status_t ajp_parse_reuse	(	request_rec *	r,
		ajp_msg_t *	msg,
		apr_byte_t *	reuse
	)

Check the reuse flag in CMD_AJP13_END_RESPONSE

Parameters

r	current request
msg	AJP message
reuse	returned reuse flag

Returns: APR_SUCCESS or error

◆ ajp_parse_type()

int ajp_parse_type	(	request_rec *	r,
		ajp_msg_t *	msg
	)

Parse the message type

Parameters

r	current request
msg	AJP message

Returns: AJP message type.

◆ ajp_read_header()

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.

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_send_data_msg()

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

Send the data message

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_send_header()

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

Build the ajp header message and send it

Parameters

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

Returns: APR_SUCCESS or error

◆ ajp_type_str()

const char* ajp_type_str ( int type )

Convert numeric message type into string

Parameters

type	AJP message type

Returns: AJP message type as a string

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ ajp_msg_append_string

◆ ajp_msg_append_string_ascii

Function Documentation

◆ ajp_alloc_data_msg()

◆ ajp_handle_cping_cpong()

◆ ajp_ilink_receive()

◆ ajp_ilink_send()

◆ ajp_msg_append_bytes()

◆ ajp_msg_append_string_ex()

◆ ajp_msg_append_uint16()

◆ ajp_msg_append_uint32()

◆ ajp_msg_append_uint8()

◆ ajp_msg_check_header()

◆ ajp_msg_copy()

◆ ajp_msg_create()

◆ ajp_msg_dump()

◆ ajp_msg_end()

◆ ajp_msg_get_bytes()

◆ ajp_msg_get_string()

◆ ajp_msg_get_uint16()

◆ ajp_msg_get_uint32()

◆ ajp_msg_get_uint8()

◆ ajp_msg_log()

◆ ajp_msg_peek_uint16()

◆ ajp_msg_peek_uint8()

◆ ajp_msg_reset()

◆ ajp_msg_reuse()

◆ ajp_msg_serialize_cping()

◆ ajp_msg_serialize_ping()

◆ ajp_parse_data()

◆ ajp_parse_header()

◆ ajp_parse_reuse()

◆ ajp_parse_type()

◆ ajp_read_header()

◆ ajp_send_data_msg()

◆ ajp_send_header()

◆ ajp_type_str()