sccp_user.h File Reference

#include <inttypes.h>
#include <osmocom/core/fsm.h>
#include <osmocom/core/prim.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/sigtran/sccp_sap.h>

Go to the source code of this file.

Data Structures
struct	osmo_sccp_user

Macros
#define	_LOGPSCU(scu, subsys, level, fmt, args ...)    _LOGPSCI((scu)->inst, subsys, level, "SCU(%s) " fmt, osmo_sccp_user_name(scu), ## args)
#define	LOGPSCU(scu, level, fmt, args ...)    _LOGPSCU(scu, DLSCCP, level, fmt, ## args)

Functions
struct osmo_sccp_user *	sccp_user_alloc (struct osmo_sccp_instance *inst, const char *name, osmo_prim_cb prim_cb, uint16_t ssn, uint32_t pc)
void	sccp_user_free (struct osmo_sccp_user *scu)
int	sccp_user_prim_up (struct osmo_sccp_user *scut, struct osmo_scu_prim *prim)
	Send a SCCP User SAP Primitive up to the User. More...
enum sccp_refusal_cause	scu_rel_reason_to_sccp_refusal_cause (enum osmo_sccp_originator originator, uint32_t reason)
enum sccp_release_cause	scu_rel_reason_to_sccp_release_cause (enum osmo_sccp_originator originator, uint32_t reason)
void	sccp_refusal_cause_to_scu_rel_reason (enum osmo_sccp_originator *originator, uint32_t *reason, uint32_t sccp_cause)
void	sccp_release_cause_to_scu_rel_reason (enum osmo_sccp_originator *originator, uint32_t *reason, uint32_t sccp_cause)

Macro Definition Documentation

_LOGPSCU

#define _LOGPSCU	(		scu,
			subsys,
			level,
			fmt,
			args ...
	)		_LOGPSCI((scu)->inst, subsys, level, "SCU(%s) " fmt, osmo_sccp_user_name(scu), ## args)

LOGPSCU

#define LOGPSCU	(		scu,
			level,
			fmt,
			args ...
	)		_LOGPSCU(scu, DLSCCP, level, fmt, ## args)

Function Documentation

sccp_refusal_cause_to_scu_rel_reason()

void sccp_refusal_cause_to_scu_rel_reason	(	enum osmo_sccp_originator *	originator,
		uint32_t *	reason,
		uint32_t	sccp_cause
	)

References OSMO_SCCP_ORIG_NS_PROVIDER, OSMO_SCCP_ORIG_NS_USER, OSMO_SCCP_REL_REASON_NSP_CREF_DST_ADDR_UNKNOWN_NT, OSMO_SCCP_REL_REASON_NSP_CREF_DST_INACC_NT, OSMO_SCCP_REL_REASON_NSP_CREF_DST_INACC_T, OSMO_SCCP_REL_REASON_NSP_CREF_HOP_COUNTER_VIOLATION, OSMO_SCCP_REL_REASON_NSP_CREF_QOS_UNAVAIL_NT, OSMO_SCCP_REL_REASON_NSP_CREF_QOS_UNAVAIL_T, OSMO_SCCP_REL_REASON_NSP_CREF_REASON_UNSPEC_NT, OSMO_SCCP_REL_REASON_NSP_CREF_REASON_UNSPEC_T, OSMO_SCCP_REL_REASON_NSU_CREF_END_USER_CONGESTION, OSMO_SCCP_REL_REASON_NSU_CREF_END_USER_FAILURE, OSMO_SCCP_REL_REASON_NSU_CREF_END_USER_ORIGIN, OSMO_SCCP_REL_REASON_NSU_CREF_INCOMPAT_INFO_NSDU, OSMO_SCCP_REL_REASON_NSU_CREF_SCCP_USER_ORIGINATED, OSMO_SCCP_REL_REASON_NSU_CREF_SUBSYS_CONGESTION, OSMO_SCCP_REL_REASON_NSU_DISC_ACCESS_CONGESTION, and OSMO_SCCP_REL_REASON_NSU_DISC_ACCESS_FAILURE.

Referenced by sccp_conn_scu_gen_encode_and_send().

sccp_release_cause_to_scu_rel_reason()

void sccp_release_cause_to_scu_rel_reason	(	enum osmo_sccp_originator *	originator,
		uint32_t *	reason,
		uint32_t	sccp_cause
	)

References OSMO_SCCP_ORIG_NS_PROVIDER, OSMO_SCCP_ORIG_NS_USER, OSMO_SCCP_REL_REASON_NSP_DISC_NT, OSMO_SCCP_REL_REASON_NSP_DISC_T, OSMO_SCCP_REL_REASON_NSU_CREF_SCCP_USER_ORIGINATED, OSMO_SCCP_REL_REASON_NSU_DISC_ABNORMAL, OSMO_SCCP_REL_REASON_NSU_DISC_ACCESS_CONGESTION, OSMO_SCCP_REL_REASON_NSU_DISC_ACCESS_FAILURE, OSMO_SCCP_REL_REASON_NSU_DISC_END_USER_CONGESTION, OSMO_SCCP_REL_REASON_NSU_DISC_END_USER_FAILURE, OSMO_SCCP_REL_REASON_NSU_DISC_NORMAL, and OSMO_SCCP_REL_REASON_NSU_DISC_SUBSYS_CONGESTION.

Referenced by sccp_conn_scu_gen_encode_and_send().

sccp_user_alloc()

struct osmo_sccp_user * sccp_user_alloc	(	struct osmo_sccp_instance *	inst,
		const char *	name,
		osmo_prim_cb	prim_cb,
		uint16_t	ssn,
		uint32_t	pc
	)

References osmo_sccp_user::inst, osmo_sccp_user::list, osmo_sccp_user::name, osmo_sccp_user::pc, pc, osmo_sccp_user::prim_cb, osmo_sccp_user::ssn, ssn, and osmo_sccp_instance::users.

Referenced by sccp_user_bind_pc().

sccp_user_free()

void sccp_user_free

(

struct osmo_sccp_user *

scu

)

References osmo_sccp_user::list, and sccp_user_flush_connections().

Referenced by osmo_sccp_user_unbind().

sccp_user_prim_up()

int sccp_user_prim_up	(	struct osmo_sccp_user *	scu,
		struct osmo_scu_prim *	prim
	)

Send a SCCP User SAP Primitive up to the User.

Parameters

[in]	scu	SCCP User to whom to send the primitive
[in]	prim	Primitive to send to the user

Returns

return value of the SCCP User's prim_cb() function

Ownership of prim->oph->msg is passed to the user of the registered callback

References LOGPSCU, osmo_scu_prim::oph, osmo_scu_prim_name(), and osmo_sccp_user::prim_cb.

Referenced by sccp_conn_scu_gen_encode_and_send(), sccp_lbcs_local_bcast_pcstate(), sccp_lbcs_local_bcast_state(), sclc_rx_cldr(), and sclc_rx_cldt().

scu_rel_reason_to_sccp_refusal_cause()

enum sccp_refusal_cause scu_rel_reason_to_sccp_refusal_cause	(	enum osmo_sccp_originator	originator,
		uint32_t	reason
	)

References OSMO_SCCP_ORIG_NS_PROVIDER, OSMO_SCCP_ORIG_NS_USER, OSMO_SCCP_ORIG_UNDEFINED, scu_rel_reason_nsp_to_sccp_refusal_cause(), and scu_rel_reason_nsu_to_sccp_refusal_cause().

Referenced by xua_gen_msg_co().

scu_rel_reason_to_sccp_release_cause()

enum sccp_release_cause scu_rel_reason_to_sccp_release_cause	(	enum osmo_sccp_originator	originator,
		uint32_t	reason
	)

References OSMO_SCCP_ORIG_NS_PROVIDER, OSMO_SCCP_ORIG_NS_USER, OSMO_SCCP_ORIG_UNDEFINED, scu_rel_reason_nsp_to_sccp_release_cause(), and scu_rel_reason_nsu_to_sccp_release_cause().

Referenced by scoc_fsm_conn_pend_out(), and xua_gen_msg_co().