A supplement to SIP message processing. More...

#include <res_pjsip.h>

Collaboration diagram for ast_sip_supplement:

Data Fields
int(*	incoming_request )(struct ast_sip_endpoint endpoint, struct pjsip_rx_data rdata)
	Called on incoming SIP request This method can indicate a failure in processing in its return. If there is a failure, it is required that this method sends a response to the request. This method is always called from a SIP servant thread. More...

void(*	incoming_response )(struct ast_sip_endpoint endpoint, struct pjsip_rx_data rdata)
	Called on an incoming SIP response This method is always called from a SIP servant thread. More...

const char *	method

struct {
struct ast_sip_supplement * next

}	next

void(*	outgoing_request )(struct ast_sip_endpoint endpoint, struct ast_sip_contact contact, struct pjsip_tx_data *tdata)
	Called on an outgoing SIP request This method is always called from a SIP servant thread. More...

void(*	outgoing_response )(struct ast_sip_endpoint endpoint, struct ast_sip_contact contact, struct pjsip_tx_data *tdata)
	Called on an outgoing SIP response This method is always called from a SIP servant thread. More...

enum ast_sip_supplement_priority	priority

Detailed Description

A supplement to SIP message processing.

These can be registered by any module in order to add processing to incoming and outgoing SIP out of dialog requests and responses

Definition at line 2888 of file res_pjsip.h.

Field Documentation

◆ incoming_request

int(* incoming_request) (struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata)

Called on incoming SIP request This method can indicate a failure in processing in its return. If there is a failure, it is required that this method sends a response to the request. This method is always called from a SIP servant thread.

Note: The following PJSIP methods will not work properly: pjsip_rdata_get_dlg() pjsip_rdata_get_tsx() The reason is that the rdata passed into this function is a cloned rdata structure, and its module data is not copied during the cloning operation. If you need to get the dialog, you can get it via session->inv_session->dlg.; There is no guarantee that a channel will be present on the session when this is called.

Definition at line 2910 of file res_pjsip.h.

Referenced by supplement_on_rx_request().

◆ incoming_response

void(* incoming_response) (struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata)

Called on an incoming SIP response This method is always called from a SIP servant thread.

Note: The following PJSIP methods will not work properly: pjsip_rdata_get_dlg() pjsip_rdata_get_tsx() The reason is that the rdata passed into this function is a cloned rdata structure, and its module data is not copied during the cloning operation. If you need to get the dialog, you can get it via session->inv_session->dlg.; There is no guarantee that a channel will be present on the session when this is called.

Definition at line 2926 of file res_pjsip.h.

Referenced by send_request_cb().