tc.h

OpenSS7 This the fourth public release of the OpenSS7 Master Package. See README in the release for

	t_uscalar_t SRC_offset;		/* Source address offset */
	t_uscalar_t DEST_length;	/* Destination address length */
	t_uscalar_t DEST_offset;	/* Destination address offset */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* Components preset flag */
} TC_uni_ind_t;

/*
 *  TC_BEGIN_REQ.  Requests the opening of a dialog.  One M_PROTO block
 *  followed by one or more M_DATA blocks containing User Information.
 *  Components to be delivered in the structured dialog must have been
 *  previously provided wtih the same Dialog Id and using the component
 *  handling request primitives.  An Application Context is required if there
 *  is User Information in attached M_DATA blocks.
 *
 *  Also T_QUERY_REQ for ANSI.
 */
typedef struct TC_begin_req {
	t_uscalar_t PRIM_type;		/* Always TC_BEGIN_REQ */
	t_uscalar_t SRC_length;		/* Source address length */
	t_uscalar_t SRC_offset;		/* Source address offset */
	t_uscalar_t DEST_length;	/* Destination address length */
	t_uscalar_t DEST_offset;	/* Destination address offset */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* For use with ANSI QWP/QWOP */
} TC_begin_req_t;

typedef struct TC_begin_req TC_query_req;

/*
 *  TC_BEGIN_IND.  Indicates the opening of a dialog.  One M_PROTO block
 *  followed by one or more M_DATA blocks containing User Information.
 *  Components to be delivered in the structured dialog will be subsequently
 *  indicated with the same Dialog Id and using the component handling
 *  indication primitives.  An Application Context is present if there is User
 *  Information in attached M_DATA blocks.
 *
 *  Also T_QUERY_IND for ANSI.
 */
typedef struct TC_begin_ind {
	t_uscalar_t PRIM_type;		/* Always TC_BEGIN_IND */
	t_uscalar_t SRC_length;		/* Source address length */
	t_uscalar_t SRC_offset;		/* Source address offset */
	t_uscalar_t DEST_length;	/* Destination address length */
	t_uscalar_t DEST_offset;	/* Destination address offset */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* For use with ANSI QWP/QWOP */
} TC_begin_ind_t;

typedef struct TC_begin_ind TC_query_ind;

/*
 *  TC_END_REQ.
 *
 *  Also TC_RESP_REQ for ANSI.
 */
typedef struct TC_end_req {
	t_uscalar_t PRIM_type;		/* Always TC_END_REQ */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t TERM_scenario;	/* Reason for termination */
} TC_end_req_t;

typedef struct TC_end_req TC_resp_req_t;

/*
 *  TC_END_IND.
 *
 *  Also TC_RESP_IND for ANSI.
 */
typedef struct TC_end_ind {
	t_uscalar_t PRIM_type;		/* Always TC_END_IND */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* Components present flag */
} TC_end_ind_t;

typedef struct TC_end_ind TC_resp_ind_t;

/*
 *  TC_CONT_REQ.  The first TC_CONT_REQ after a TC_BEGIN_IND requests
 *  that the dialog be confirmed and may contain the Source address and
 *  Application Context parameters.  Once these have been provided on the
 *  first TC_CONT_REQ, they are in place for the remainder of the dialog.
 *  Subsequent TC_CONT_REQ primitives do not contain the SRC and CONTEXT
 *  parameters.
 *
 *  Also TC_CONV_REQ for ANSI.
 */
typedef struct TC_begin_res {
	t_uscalar_t PRIM_type;		/* Always TC_CONT_REQ */
	t_uscalar_t SRC_length;		/* Source address length */
	t_uscalar_t SRC_offset;		/* Source address offset */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* For use with ANSI CWP/CWOP */
} TC_begin_res_t;

typedef struct TC_cont_req {
	t_uscalar_t PRIM_type;		/* Always TC_CONT_REQ */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* For use with ANSI CWP/CWOP */
} TC_cont_req_t;

typedef struct TC_cont_req TC_conv_req_t;

/*
 *  TC_CONT_IND.  The first TC_CONT_IND after a TC_BEGIN_REQ indicates
 *  that the dialog is confirmed but may contain the Source address and
 *  Application Context parameters.  Once these have been provided on the
 *  first TC_CONT_IND, they are in place for the remainder of the dialog.
 *  Subsequent TC_CONT_IND primitives will not contain the SRC and CONTEXT
 *  parameters.
 *
 *  Also TC_CONV_IND for ASNI.
 */
typedef struct TC_begin_con {
	t_uscalar_t PRIM_type;		/* Always TC_BEGIN_CON */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* For use with ANSI CWP/CWOP */
} TC_begin_con_t;

typedef struct TC_cont_ind {
	t_uscalar_t PRIM_type;		/* Always TC_CONT_IND */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t COMP_flags;		/* For use with ANSI CWP/CWOP */
} TC_cont_ind_t;

typedef struct TC_cont_ind TC_conv_ind_t;

/*
 *  TC_ABORT_REQ.
 *
 *  Note:   Application context is only present if the abort reason indicates
 *          "application context not supported".
 */
typedef struct TC_abort_req {
	t_uscalar_t PRIM_type;		/* Always TC_ABORT_REQ */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t ABORT_reason;	/* Abort reason */
} TC_abort_req_t;

/*
 *  TC_ABORT_IND.
 *
 *  Note:   Application context is only present if the abort reason indicates
 *          "application context not supported".
 */
typedef struct TC_abort_ind {
	t_uscalar_t PRIM_type;		/* Always TC_ABORT_IND */
	t_uscalar_t OPT_length;		/* Options associated with the primitive */
	t_uscalar_t OPT_offset;		/* Options associated wtih the primitive */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t ABORT_reason;	/* Abort reason */
	t_uscalar_t ORIGINATOR;		/* Either User or Provider originated */
} TC_abort_ind_t;

/*
 *  TC_NOTICE_IND.
 */
typedef struct TC_notice_ind {
	t_uscalar_t PRIM_type;		/* Always TC_NOTICE_IND */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t REPORT_cause;	/* Report cause */
} TC_notice_ind_t;

/*
 *  Component handling primitives.
 */

/*
 *  TC_INVOKE_REQ.  This primitive is one M_PROTO message block followed by
 *  zero or more M_DATA blocks containing the parameters of the operation.
 */
typedef struct TC_invoke_req {
	t_uscalar_t PRIM_type;		/* Always TC_INVOKE_REQ */
	t_uscalar_t DIALOG_id;		/* Dialog identifier */
	t_uscalar_t PROTOCOL_class;	/* Application protocol class */
	t_uscalar_t INVOKE_id;		/* Invoke Identifier */
	t_uscalar_t LINKED_id;		/* Linked Invoke Identifier */
	t_uscalar_t OPERATION;		/* Requested operation to invoke */
	t_uscalar_t MORE_flag;		/* Not last */
	t_uscalar_t TIMEOUT;		/* Timeout */
} TC_invoke_req_t;

/*
 *  TC_INVOKE_IND.  This primitive is one M_PROTO message block followed by
 *  zero or more M_DATA blocks containing the parameters of the operation.
 *
 *  Note:   Dialog Id is ignored for Class 4 (TC_UNI_IND) operations.
 */
typedef struct TC_invoke_ind {
	t_uscalar_t PRIM_type;		/* Always TC_INVOKE_IND */
	t_uscalar_t DIALOG_id;		/* Dialog identifier */
	t_uscalar_t OP_class;		/* Application operation class */
	t_uscalar_t INVOKE_id;		/* Invoke Identifier */
	t_uscalar_t LINKED_id;		/* Linked Invoke Identifier */
	t_uscalar_t OPERATION;		/* Requested operation to invoke */
	t_uscalar_t MORE_flag;		/* Not last */
} TC_invoke_ind_t;

/*
 *  TC_RESULT_REQ.  This primitive consists of one M_PROTO message block
 *  followed by zero or more M_DATA blocks containing the parameters of the
 *  operation.
 */
typedef struct TC_result_req {
	t_uscalar_t PRIM_type;		/* Always TC_RESULT_REQ */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke Identifier */
	t_uscalar_t OPERATION;		/* Requested operation result */
	t_uscalar_t MORE_flag;		/* Not last */
} TC_result_req_t;

/*
 *  TC_RESULT_IND.  This primitive consists of one M_PROTO message block
 *  followed by zero or more M_DATA blocks containing the parameters of the
 *  operation.
 *
 *  This primitive is only valid (expected) for operation class 1 and 3.
 */
typedef struct TC_result_ind {
	t_uscalar_t PRIM_type;		/* Always TC_RESULT_IND */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke Identifier */
	t_uscalar_t OPERATION;		/* Requested operation result */
	t_uscalar_t MORE_flag;		/* Not last */
} TC_result_ind_t;

/*
 *  TC_ERROR_REQ.  This primitive consists of one M_PROTO message block
 *  followed by zero or more M_DATA blocks containing the parameters of the
 *  error.
 */
typedef struct TC_error_req {
	t_uscalar_t PRIM_type;		/* Always TC_ERROR_REQ */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke Identifier */
	t_uscalar_t ERROR_code;		/* Error code */
	t_uscalar_t MORE_flag;		/* Not last */
} TC_error_req_t;

/*
 *  TC_ERROR_IND.  This primitive consists of one M_PROTO message block
 *  followed by zero or more M_DATA blocks containing the parameters of the
 *  error.
 */
typedef struct TC_error_ind {
	t_uscalar_t PRIM_type;		/* Always TC_ERROR_IND */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke Identifier */
	t_uscalar_t ERROR_code;		/* Error code */
} TC_error_ind_t;

/*
 *  TC_REJECT_REQ.  This primitive consists of one M_PROTO message block.
 */
typedef struct TC_reject_req {
	t_uscalar_t PRIM_type;		/* Always TC_REJECT_REQ */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke identifier */
	t_uscalar_t PROBLEM_code;	/* Problem code */
} TC_reject_req_t;

/*
 *  TC_REJECT_IND.  This primitive consists of one M_PROTO message block.
 */
typedef struct TC_reject_ind {
	t_uscalar_t PRIM_type;		/* Always TC_REJECT_IND */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke identifier */
	t_uscalar_t ORIGINATOR;		/* Either User, Local or Remote */
	t_uscalar_t PROBLEM_code;	/* Problem code */
} TC_reject_ind_t;

/*
 *  TC_CANCEL_REQ.  This primitive consists of one M_PROTO message block.
 */
typedef struct TC_cancel_req {
	t_uscalar_t PRIM_type;		/* Always TC_CANCEL_REQ */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke identifier */
} TC_cancel_req_t;

/*
 *  TC_CANCEL_IND.  This primitive consists of one M_PROTO message block.
 */
typedef struct TC_cancel_ind {
	t_uscalar_t PRIM_type;		/* Always TC_CANCEL_REQ */
	t_uscalar_t DIALOG_id;		/* Dialog Identifier */
	t_uscalar_t INVOKE_id;		/* Invoke identifier */
} TC_cancel_ind_t;

#endif				/* __SS7_TC_H__ */