Appendix B . Obsolete Message-Based Services for Message Broadcasting

This chapter contains reference information for the following obsolete services for message broadcasting:

SBS_BS_SEQGAP

Note: This service is obsolete. Use SBS_SEQUENCE_GAP instead.

Applications can register to receive notification of sequence gaps in broadcast messages when sending the SBS_REG message to the SBS Server. The registered application receives an SBS_BS_SEQGAP message when there is a gap in sequence of broadcast messages. Sequence gaps can occur when the sender program is broadcasting at a higher rate than the receiver program can handle.

C Message Structure

typedef struct _SBS_BS_SEQGAP {
    int32 num_msgs_missing;
    uint16 sender_group;
    uint16 mot;
    uint16 channel;
    } SBS_BS_SEQGAP;

Message Data Fields


Field	Data Type	Script Format	Description
num_msgs_ missing	int32	DL	Count of lost messages in sequence gap.
sender_group	unsigned word	DW	Group address of sending SBS Server.
mot	unsigned word	DW	Multipoint Outbound Target (MOT) address in which broadcast stream gap occurred.
channel	unsigned word	DW	Source address of MOT; either SBS Server or Ethernet channel.

Arguments


Argument	Script Format	pams_get_msg Format
Target	Requesting program	Requesting program
Source	SBS_SERVER	PAMS_SBS_SERVER
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_BS_SEQGAP	MSG_TYPE_SBS_BS_SEQGAP

SBS_DEREG

Note: This service is obsolete. Use SBS_DEREGISTER_REQ instead.

Applications can register to receive broadcast messages by sending an SBS_REG message or an SBS_REG_EZ message to the SBS Server. When an application no longer needs to receive messages from a broadcast stream, it sends an SBS_DEREG message to the SBS Server. This message causes the SBS Server to deregister all entries for the broadcast stream and receiving queue combination.

C Message Structure

typedef struct _SBS_DEREG {
    int16 version;
    uint16 mot;
    q_address distribution_q;
    char req_ack;
    } SBS_DEREG;

Message Data Fields


Field	Data Type	Script Format	Description
version	word	DW	Message format version. Must be 20.
mot_q	unsigned word	DW	MOT queue address.
distribution_q	q_address	DL	Distribution queue address.
req_ack	Boolean	DB	Value of 1 if acknowledgment requested.

Arguments


Argument	Script Format	pams_get_msg Format
Target	SBS_SERVER	PAMS_SBS_SERVER
Source	Requesting program	Requesting program
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_DEREG	MSG_TYPE_SBS_DEREG

See Also

SBS_BS_SEQGAP
SBS_DEREG_ACK
SBS_DEREG_BY_ID
SBS_REG
SBS_REG_EZ

SBS_DEREG_ACK

Note: This service is obsolete. Use SBS_DEREGISTER_RESP instead.

C Message Structure

typedef struct _SBS_DEREG_ACK {
    int16 status;
    int16 number_reg;
    } SBS_DEREG_ACK;

Message Data Fields


Field	Data Type	Script Format	Description
status	word	DW	The return status of 1 = success, -n = failure.
number_reg	word	DW	Number of registrants left on this Multipoint Outbound Target (MOT) after deregistration.

Arguments


Argument	Script Format	pams_get_msg Format
Target	Requesting program	Requesting program
Source	SBS_SERVER	PAMS_SBS_SERVER
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_DEREG_ACK	MSG_TYPE_SBS_DEREG_ACK

SBS_DEREG_BY_ID

Note: This service is obsolete. Use SBS_DEREGISTER_REQ instead.

Applications can register to receive broadcast messages by sending an SBS_REG message or an SBS_REG_EZ message to the SBS Server. When an application has multiple registrations for a broadcast stream and no longer needs to receive one type of message, the application can send an SBS_DEREG_BY_ID message to the SBS Server by providing the ID returned by MessageQ during the initial broadcast registration. The queue will continue to receive broadcast messages requested through separate registrations.

C Message Structure

typedef struct _SBS_DEREG_BY_ID {
    short version;
    unsigned short reg_id;
    char req_ack;
    } SBS_DEREG_BY_ID;

Message Data Fields


Field	Data Type	Script Format	Description
version	word	DW	Message format version. Must be 20.
reg_id	unsigned word	DW	Registration ID.
req_ack	Boolean	DB	Value of 1 if ACK requested.

Arguments


Argument	Script Format	pams_get_msg Format
Target	SBS_SERVER	PAMS_SBS_SERVER
Source	Requesting program	Requesting program
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_DEREG_BY_ID	MSG_TYPE_SBS_DEREG_BY_ID

SBS_REG

Note: This service is obsolete. Use SBS_REGISTER_REQ instead.

Applications can register to receive selected messages from a broadcast stream by sending an SBS_REG message to the SBS Server. This message requests a target queue to receive all messages that meet the selection criteria entered as part of the registration process. Selection rules define a relational operation to be applied against a message header or message data field. Each broadcast message that matches the rule is distributed to the target queue.

C Message Structure

typedef struct _SBS_REG {
    int16 version;
    uint16 mot;
    q_address distribution_q;
    int16 offset;
    char data_operator;
    int16 length;
    uint32 operand;
    char req_ack;
    char req_seqgap;
    char req_autodereg;
    } SBS_REG;

Message Data Fields


Field	Data Type	Script Format	Description
version	word	DW	Message format version number. Must be 20.
mot_addr	unsigned word	DW	The Multipoint Outbound Target (MOT) broadcast stream to which the program tries to register.
distribution_q	q_address	DL	The MessageQ address that receives any messages that are selected from the broadcast stream.
offset	word	DW	Specifies a field in the message header or in the message data component.
operator	byte	DB	Controls the type of comparison to be performed on the field designated by the data offset and the operand.
length	word	DW	Specifies the size of comparison to be performed. The choices are 0, 1, 2, and 4.
operand	uint32	DL	The value to be used in the comparison of the field specified by the data offset.
req_ack	Boolean	DB	Specifies if an acknowledgment message is requested. See SBS_REG_REPLY.
req_seqgap	Boolean	DB	Specifies if a notification of broadcast stream message sequence number gap is requested.
req_autodereg	Boolean	DB	Specifies if a registration request is to be automatically purged from the SBS Server table.

Arguments


Argument	Script Format	pams_get_msg Format
Target	SBS_SERVER	PAMS_SBS_SERVER
Source	Requesting program	Requesting program
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_REG	MSG_TYPE_SBS_REG

SBS_REG_EZ

Note: This service is obsolete. Use SBS_REGISTER_REQ instead.

Applications can register to receive all messages from a broadcast stream by sending an SBS_REG_EZ message to the SBS Server. This message requests a target queue to receive all messages sent to the selected broadcast stream.

C Message Structure

typedef struct _SBS_REG_EZ {
    int16 version;
    int16 mot;
    q_address distribution_q;
    } SBS_REG_EZ;

Message Data Fields


Field	Data Type	Script Format	Description
version	word	DW	Message format version number. Must be 20.
mot_addr	word	DW	The Multipoint Outbound Target (MOT) broadcast stream to which the process tries to subscribe.
distribution_q	q_address	DL	The MessageQ address that receives any messages selected from the broadcast stream.

Arguments


Argument	Script Format	pams_get_msg Format
Target	SBS_SERVER	PAMS_SBS_SERVER
Source	Requesting program	Requesting program
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_REG_EZ	MSG_TYPE_SBS_REG_EZ

SBS_REG_EZ_REPLY

Note: This service is obsolete. Use SBS_REGISTER_RESP instead.

Applications can register to receive all messages from a broadcast stream by sending an SBS_REG_EZ message to the SBS Server. This message requests that all messages sent to a broadcast stream be distributed to a particular target queue. The SBS_REG_EZ_REPLY message indicates the status of the request and returns a registration ID if the application is successfully registered.

C Message Structure

typedef struct _SBS_REG_EZ_REPLY {
    int16 status;
    uint16 reg_id;
    int16 number_reg;
    } SBS_REG_EZ_REPLY;

Message Data Fields


Field	Data Type	Script Format	Description
status	word	DW	The return status of 1indicates success; -n indicates failure.
reg_id	unsigned word	DW	Returned registration ID.
number_reg	word	DW	Number of registrants left on this Multipoint Outbound Target (MOT).

Arguments


Argument	Script Format	pams_get_msg Format
Target	Requesting program	Requesting program
Source	SBS_SERVER	PAMS_SBS_SERVER
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_REG_EZ_REPLY	MSG_TYPE_SBS_REG_EZ_REPLY

SBS_REG_REPLY

Note: This service is obsolete. Use SBS_REGISTER_RESP instead.

Applications can register to receive selected messages from a broadcast stream by sending an SBS_REG message to the SBS Server. This message requests a target queue to receive all messages sent to a particular broadcast stream that meet selection criteria. The SBS_REG_REPLY message indicates the status of the request and returns a registration ID.

C Message Structure

typedef struct _SBS_REG_REPLY {
    int16 status;
    uint16 reg_id;
    int16 number_reg;
    } SBS_REG_REPLY;

Message Data Fields


Field	Data Type	Script Format	Description
status	word	DW	The return status of 1 = success, -n = failure.
reg_id	unsigned word	DW	Returned registration ID.
number_reg	word	DW	Number of registrants left on this Multipoint Outbound Target (MOT).

Arguments


Argument	Script Format	pams_get_msg Format
Target	Requesting program	Requesting program
Source	SBS_SERVER	PAMS_SBS_SERVER
Class	PAMS	MSG_CLAS_PAMS
Type	SBS_REG_REPLY	MSG_TYPE_SBS_REG_REPLY