Class Reference
IRIS for UNIX 2019.4
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Net] >  [MQSend]
Private  Storage   

class %Net.MQSend extends %Net.abstractMQ

The MQSend class is used to put messages on a queue.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 8


Summary

Properties
ApplIdentityData Channel CharSetId Connection
Context CorrelationId GeneratedMessageId MQCloseQID
MQCommitID MQConnectID MQDeleteID MQDisconnID
MQErrLogID MQGetID MQGetLastErrID MQGetStreamID
MQMsgDescID MQMsgDescIID MQMsgDescSetID MQOpenQID
MQOpenTopicID MQPutID MQPutStreamID MQSetChannelID
MQSetUserPassID MQSubscribeID MessageId Password
PutApplType QMBehavior QMgr QName
ReplyQMgrName ReplyQName SSLCipherSpec Syncpoint
Transport Username mDesc mDllid
qtype

Methods
%%OIDGet %AddToSaveSet %ApplIdentityData %Backout
%BindExport %BuildObjectGraph %CharSet %ClassIsLatestVersion
%ClassName %Close %Commit %Connect
%ConstructClone %CorId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %ErrLog %Extends %GetLastError
%GetParameter %IncrementCount %Init %IsA
%IsModified %MsgId %New %NormalizeObject
%ObjectModified %OriginalNamespace %PackageName %Put
%PutApplType %PutStream %RemoveFromSaveSet %ReplyQMgrName
%ReplyQName %SerializeObject %SetApplIdentityData %SetCharSet
%SetCorId %SetModified %SetMsgId %SetPutApplType
%SetReplyQMgrName %SetReplyQName %Syncpoint %ValidateObject

Subclasses
%Net.MQPub

Properties

• property GeneratedMessageId as %String;
Generated message id
• property qtype as %Integer [ InitialExpression = 1 ];
MQ type

Methods

• method %Put(Msg As %Library.String) as %Boolean
Use the %Put method to write a message to the queue specified in the %Init method.  The %Put method takes one argument, the message.  The message can be up to 32K bytes long.

%Put returns 0 if the call failed, else 1.

• method %PutStream(stream As %Stream) as %Boolean
Identical to %Put except the queue message is input from a file character stream object which has been created by the caller.

Data is read from the start to the end of the file, and the entire stream put on the queue as a single message.

• method %SetApplIdentityData(Value As %Library.String) as %Boolean
Sets the Application Identity for the next message to be sent. 
• method %SetCorId(Value As %Library.String) as %Boolean
Sets the Correlation Id for the next message to be sent. 
• method %SetMsgId(Value As %Library.String) as %Boolean
The %SetMsgId method sets the Message Id for the next message to be sent. 
• method %SetPutApplType(Value As %Library.String) as %Boolean
Sets the Put Application Type for the next message to be sent. 
• method %SetReplyQMgrName(Value As %Library.String) as %Boolean
Sets the Reply Queue Manager Name for the next message to be sent. 
• method %SetReplyQName(Value As %Library.String) as %Boolean
Sets the Reply Queue Name for the next message to be sent. 


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.