channel_info.h File Reference

Channel-locked PJSIP information interface. More...

#include <pjsip.h>
#include "asterisk/channel.h"
#include "asterisk/res_pjsip_session.h"

Include dependency graph for channel_info.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pjsip_channel_info
struct	pjsip_channel_uri

Functions
int	pjsip_channel_info_create (struct ast_channel *chan, struct ast_sip_session *session)
	Create channel-owned PJSIP information before channel publication.
struct pjsip_channel_info *	pjsip_channel_info_get (struct ast_channel *chan)
	Find the channel's information, or NULL if it has none.
void	pjsip_channel_info_register (void)
	Register the channel information session supplement.
void	pjsip_channel_info_schedule_update (struct ast_sip_session *session)
	Schedule a refresh from any thread without waiting for the serializer.
void	pjsip_channel_info_unregister (void)
	Unregister the channel information session supplement.
void	pjsip_channel_info_update (struct ast_sip_session *session)
	Refresh channel information under the channel lock.

Detailed Description

Channel-locked PJSIP information interface.

Definition in file channel_info.h.

Function Documentation

pjsip_channel_info_create()

int pjsip_channel_info_create	(	struct ast_channel *	chan,
		struct ast_sip_session *	session
	)

Create channel-owned PJSIP information before channel publication.

Precondition

The caller holds the channel lock and executes in the session serializer.

Return values

0	on success
-1	on failure

Definition at line 187 of file channel_info.c.

{
    struct ast_datastore *datastore;
    struct pjsip_channel_info *info;
 
    datastore = ast_datastore_alloc(&channel_info_datastore, NULL);
    if (!datastore) {
        return -1;
    }
    info = ast_calloc(1, sizeof(*info));
    if (!info) {
        ast_datastore_free(datastore);
        return -1;
    }
    info->datastore = datastore;
    info->secure = -1;
    datastore->data = info;
 
    /* The caller holds the channel lock and is running in the serializer. */
    channel_info_update_locked(info, session);
    ast_channel_datastore_add(chan, datastore);
    return 0;
}

References ast_calloc, ast_channel_datastore_add(), ast_datastore_alloc, ast_datastore_free(), channel_info_datastore, channel_info_update_locked(), ast_datastore::data, pjsip_channel_info::datastore, NULL, and session.

Referenced by chan_pjsip_new().

pjsip_channel_info_get()

struct pjsip_channel_info * pjsip_channel_info_get

(

struct ast_channel *

chan

)

Find the channel's information, or NULL if it has none.

Precondition

The caller holds the channel lock.

Note

The result is borrowed and may only be used while the channel is locked. Do not release it with ao2_cleanup(). The channel datastore owns its lifetime.

Definition at line 89 of file channel_info.c.

{
    struct ast_datastore *datastore;
 
    datastore = ast_channel_datastore_find(chan, &channel_info_datastore, NULL);
    return datastore ? datastore->data : NULL;
}

References ast_channel_datastore_find(), channel_info_datastore, ast_datastore::data, and NULL.

Referenced by channel_read_pjsip(), pjsip_acf_channel_read(), and pjsip_channel_info_update().

pjsip_channel_info_register()

void pjsip_channel_info_register

(

void

)

Register the channel information session supplement.

Definition at line 289 of file channel_info.c.

{
    ast_sip_session_register_supplement(&channel_info_supplement);
}

References ast_sip_session_register_supplement, and channel_info_supplement.

Referenced by load_module().

pjsip_channel_info_schedule_update()

void pjsip_channel_info_schedule_update

(

struct ast_sip_session *

session

)

Schedule a refresh from any thread without waiting for the serializer.

Definition at line 238 of file channel_info.c.

{
    /*
     * Capture changes made after supplements or from an outgoing transport
     * callback outside the serializer. Never wait for the queued refresh.
     */
    if (ast_sip_push_task(session->serializer, channel_info_update_task,
        ao2_bump(session))) {
        ast_log(LOG_WARNING, "Unable to queue PJSIP channel information refresh for %s\n",
            ast_sip_session_get_name(session));
        ao2_ref(session, -1);
    }
}

References ao2_bump, ao2_ref, ast_log, ast_sip_push_task, ast_sip_session_get_name(), channel_info_update_task(), LOG_WARNING, and session.

Referenced by channel_info_incoming_request(), channel_info_incoming_response(), channel_info_outgoing_request(), and channel_info_outgoing_response().

pjsip_channel_info_unregister()

void pjsip_channel_info_unregister

(

void

)

Unregister the channel information session supplement.

Definition at line 294 of file channel_info.c.

{
    ast_sip_session_unregister_supplement(&channel_info_supplement);
}

References ast_sip_session_unregister_supplement(), and channel_info_supplement.

Referenced by load_module(), and unload_module().

pjsip_channel_info_update()

void pjsip_channel_info_update

(

struct ast_sip_session *

session

)

Refresh channel information under the channel lock.

Precondition

The caller executes in the session serializer.

Definition at line 212 of file channel_info.c.

{
    struct ast_channel *chan = session->channel;
    struct pjsip_channel_info *info;
 
    /* Serializer execution stabilizes session->channel across a masquerade. */
    if (!chan) {
        return;
    }
    ast_channel_lock(chan);
    info = pjsip_channel_info_get(chan);
    if (info) {
        channel_info_update_locked(info, session);
    }
    ast_channel_unlock(chan);
}

References ast_channel_lock, ast_channel_unlock, channel_info_update_locked(), pjsip_channel_info_get(), and session.

Referenced by channel_info_incoming_request(), channel_info_incoming_response(), channel_info_update_task(), and send_direct_media_request().