Home

 

Optional parameters

IntegerData

name:

"MQPSIntData"   (string constant: MQPS_INTEGER_DATA)

value:

Optional publication data as an integer.

The meaning is as defined by the publisher. IntegerData can be repeated, interspersed with StringData tags if required, to send publication data in any manner defined by the publisher.

PublicationOptions

name:

"MQPSPubOpts"   (string constant: MQPS_PUBLICATION_OPTIONS)

value:

The following publication options can be specified:

"CorrelAsId"

(string constant: MQPS_CORREL_ID_AS_IDENTITY, integer constant: MQPUBO_CORREL_ID_AS_IDENTITY).

The CorrelId in the MQMD (which must not be zero) is part of the publisher's identity (for messages sent by a publisher to a broker). For messages sent from a broker to a subscriber, this option is not changed by the broker.

"IsRetainedPub"

(string constant: MQPS_IS_RETAINED_PUBLICATION, integer constant: MQPUBO_IS_RETAINED_PUBLICATION).

Can be set only by a broker.

This publication has been retained by the broker. The broker sets this option to notify a subscriber that this publication was published earlier and has been retained. A subscriber can receive such a publication immediately after registering (or later if a publication has been retained at another broker that is temporarily inaccessible). It can also be received in response to a Request Update command.

The broker sets this option only if the subscriber registered with theInformIfRet option.

"NoReg"

(string constant: MQPS_NO_REGISTRATION, integer constant: MQPUBO_NO_REGISTRATION).

Valid only if the recipient is a broker.

If the publisher is not already registered with the broker as a publisher for this stream and topic, this option stops the broker from performing an implicit registration. If the publisher is already registered, the registration is unchanged, and has no effect on this publication.

"OtherSubsOnly"

(string constant: MQPS_OTHER_SUBSCRIBERS_ONLY, integer constant: MQPUBO_OTHER_SUBSCRIBERS_ONLY).

Valid only if the recipient is a broker.

Allows simpler processing of conference-type applications. It tells the broker not to send the publication to the publisher even if he has subscribed. For example, a group of applications can all subscribe to the same topic (for example, "Conference"). Using this option, each application can publish information into the conference without themselves receiving the information.

"RetainPub"

(string constant: MQPS_RETAIN_PUBLICATION, integer constant: MQPUBO_RETAIN_PUBLICATION).

Valid only if the recipient is a broker.

The broker is to retain a copy of the publication. If this option is not set, the publication is deleted as soon as the broker has sent the publication to all its current subscribers.

The default is that no publication options are set.

PublishTimestamp

name:

"MQPSPubTime"   (string constant: MQPS_PUBLISH_TIMESTAMP)

value:

Optional publication timestamp set by the publisher.

This is of length 16 characters in the format: 

   YYYYMMDDHHMMSSTH

using Universal Time. However, this is not checked by the broker, which transmits this information to subscribers if it is present.

QMgrName

name:

"MQPSQMgrName"   (string constant: MQPS_Q_MGR_NAME)

value:

The publisher's queue manager name.

For a message sent by a publisher, the default is the ReplyToQMgr name in the message descriptor (MQMD). If the resulting name is blank, it represents a publisher that can be reached by resolving QName at the broker.

For a message sent by a broker, QMgrName is present only if it was explicitly included by the publisher. (Note that it is not removed by the broker if the publisher has registered withAnon)

QName

name:

"MQPSQName"   (string constant: MQPS_Q_NAME)

value:

The publisher's queue name.

For a message sent by a publisher, the default is the ReplyToQ name in the message descriptor (MQMD), which must not be blank in this case (unless PublicationOptions specifies NoReg and not OtherSubsOnly).

For a message sent by a broker, QName is present only if it was explicitly included by the publisher. (Note that it is not removed by the broker if the publisher has registered withAnon)

RegistrationOptions

name:

"MQPSRegOpts"   (string constant: MQPS_REGISTRATION_OPTIONS)

value:

The registration options listed below can be specified, subject to the following conditions:

IfNoReg is not specified in PublicationOptions:

  • If the publisher is already registered, the registration options are changed to the values specified, if this tag is present. If it is not present, the registration options are unchanged.

  • If the publisher is not already registered, an implicit registration is performed. The registration options are those specified by the RegistrationOptions parameter, if it is present. If it is not present, no options are set.

IfNoReg is specified in PublicationOptions, any current registration has no effect and it is not changed. RegistrationOptions can be specified.

IfLocal is specified in RegistrationOptions, the publication is restricted to local subscribers and any other valid options are not acted on by the broker.

The following registration options can be set:

"Anon"  

(string constant: MQPS_ANONYMOUS, integer constant: MQREGO_ANONYMOUS).

Valid only if the recipient is a broker.

Tells the broker that the identity of the publisher is not to be divulged, except to subscribers with additional authority.

This option (or the lack of it) overrides the option setting for any previous publication on the same topics (or publisher registration).

"CorrelAsId"  

(string constant: MQPS_CORREL_ID_AS_IDENTITY, integer constant: MQREGO_CORREL_ID_AS_IDENTITY).

The CorrelId in the MQMD (which must not be zero) is part of the publisher's identity. This option is assumed ifCorrelAsId is set in the PublicationOptions.

"DirectReq"  

(string constant: MQPS_DIRECT_REQUESTS, integer constant: MQREGO_DIRECT_REQUESTS).

Tells the recipient that the publisher is willing to receive direct requests for publication information from other applications (not just from the broker).

The publisher's queue and queue manager names can be included in a Publish message sent by a publisher, so that the names are visible to the subscriber.

This option (or the lack of it) overrides the option setting for any previous publication on the same topics (or registration in the case of a publisher to a broker, or the value returned in the response to a subscriber registration).

This option must not be set ifAnon is also set.

"Local"  

(string constant: MQPS_LOCAL, integer constant: MQREGO_LOCAL).

Valid only if the recipient is a broker.

Tells the broker that publications published by this publisher should be sent only to subscribers that registered at this broker specifyingLocal.

SequenceNumber

name:

"MQPSSeqNum"   (string constant: MQPS_SEQUENCE_NUMBER)

value:

Optional sequence number set by the publisher.

This should increase by 1 with each publication. However, this is not checked by the broker, which merely transmits this information to subscribers if it is present. If publications on the same stream and topic are published to different interconnected brokers, it is the responsibility of the publisher to ensure that sequence numbers, if used, are meaningful.

StreamName

name:

"MQPSStreamName"   (string constant: MQPS_STREAM_NAME)

value:

The name of the publication stream for the specified Topic(s).

This defaults to the name of the stream queue to which the message is sent if sent to a broker, or an unspecified stream name if the message is sent to a subscriber. A subscriber can request that the broker always include StreamName in Publish messages by specifying "InclStreamName" when it registers.

StringData

name:

"MQPSStringData"   (string constant: MQPS_STRING_DATA)

value:

Optional publication data as a character string.

The meaning and format are as defined by the publisher. StringData can be repeated, interspersed with IntegerData tags if required, to send publication data in any manner defined by the publisher.




 

Home