Merge pull request #123 from ibm-messaging/context

Enable PMO to pass Context

Author: ibmmqmet

CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog
 Newest updates are at the top of this file.
 
+## October 7 2019 - v4.1.1
+* ibmmq - Enable use of Context in MQPMO structure (#122)
+* ibmmq - Remove unusable fields referring to Distribution List structures
+
 ## Augest 20 2019 - v4.1.0
 * Update Docker build scripts for newer Go compiler level
-* mqmetric - Issue warning if trying to monitor queues with names containing '/' 
+* mqmetric - Issue warning if trying to monitor queues with names containing '/'
 
 ## August 2 2019 - unpublished
 * ibmmq - Add new verb GetSlice to mirror Get() but which returns ready-sized buffer (#110)

README.md

@@ -158,6 +158,9 @@ let me know, via an issue, if you have another project that might be suitable fo
 ### Package 'ibmmq'
 All regular MQI verbs are now available through the `ibmmq` package.
 
+The only unimplemented area of MQI function is the use of Distribution Lists: they were
+rarely used, and the Publish/Subscribe operations provide similar capability.
+
 ### Package 'mqmetric'
 * There is currently a queue manager limitation which does not permit resource publications to
 be made about queues whose name includes '/'. Attempting to monitor such a queue will result in a warning

ibmmq/mqiMQOD.go

@@ -44,15 +44,14 @@ type MQOD struct {
 	DynamicQName    string
 	AlternateUserId string
 
-	RecsPresent       int32
-	KnownDestCount    int32
-	UnknownDestCount  int32
-	InvalidDestCount  int32
-	ObjectRecOffset   int32
-	ResponseRecOffset int32
-
-	ObjectRecPtr   C.MQPTR
-	ResponseRecPtr C.MQPTR
+	// TODO: These fields are not currently mapped. The Dist List feature is not
+	// really supported here as Pub/Sub is the recommended approach.
+	//RecsPresent       int32
+	//KnownDestCount    int32
+	//UnknownDestCount  int32
+	//InvalidDestCount  int32
+	//ObjectRec     []MQOR
+	//ResponseRec   []MQOR
 
 	AlternateSecurityId []byte
 	ResolvedQName       string
@@ -77,16 +76,6 @@ func NewMQOD() *MQOD {
 	od.DynamicQName = "AMQ.*"
 	od.AlternateUserId = ""
 
-	od.RecsPresent = 0
-	od.KnownDestCount = 0
-	od.UnknownDestCount = 0
-	od.InvalidDestCount = 0
-	od.ObjectRecOffset = 0
-	od.ResponseRecOffset = 0
-
-	od.ObjectRecPtr = nil
-	od.ResponseRecPtr = nil
-
 	od.AlternateSecurityId = bytes.Repeat([]byte{0}, C.MQ_SECURITY_ID_LENGTH)
 	od.ResolvedQName = ""
 	od.ResolvedQMgrName = ""
@@ -137,15 +126,15 @@ func copyODtoC(mqod *C.MQOD, good *MQOD) {
 	setMQIString((*C.char)(&mqod.DynamicQName[0]), good.DynamicQName, C.MQ_OBJECT_NAME_LENGTH)
 	setMQIString((*C.char)(&mqod.AlternateUserId[0]), good.AlternateUserId, C.MQ_USER_ID_LENGTH)
 
-	mqod.RecsPresent = C.MQLONG(good.RecsPresent)
-	mqod.KnownDestCount = C.MQLONG(good.KnownDestCount)
-	mqod.UnknownDestCount = C.MQLONG(good.UnknownDestCount)
-	mqod.InvalidDestCount = C.MQLONG(good.InvalidDestCount)
-	mqod.ObjectRecOffset = C.MQLONG(good.ObjectRecOffset)
-	mqod.ResponseRecOffset = C.MQLONG(good.ResponseRecOffset)
+	mqod.RecsPresent = 0
+	mqod.KnownDestCount = 0
+	mqod.UnknownDestCount = 0
+	mqod.InvalidDestCount = 0
+	mqod.ObjectRecOffset = 0
+	mqod.ResponseRecOffset = 0
 
-	mqod.ObjectRecPtr = good.ObjectRecPtr
-	mqod.ResponseRecPtr = good.ResponseRecPtr
+	mqod.ObjectRecPtr = nil
+	mqod.ResponseRecPtr = nil
 
 	for i = 0; i < C.MQ_SECURITY_ID_LENGTH; i++ {
 		mqod.AlternateSecurityId[i] = C.MQBYTE(good.AlternateSecurityId[i])
@@ -202,15 +191,12 @@ func copyODfromC(mqod *C.MQOD, good *MQOD) {
 	good.DynamicQName = trimStringN((*C.char)(&mqod.DynamicQName[0]), C.MQ_OBJECT_NAME_LENGTH)
 	good.AlternateUserId = trimStringN((*C.char)(&mqod.AlternateUserId[0]), C.MQ_USER_ID_LENGTH)
 
-	good.RecsPresent = int32(mqod.RecsPresent)
-	good.KnownDestCount = int32(mqod.KnownDestCount)
-	good.UnknownDestCount = int32(mqod.UnknownDestCount)
-	good.InvalidDestCount = int32(mqod.InvalidDestCount)
-	good.ObjectRecOffset = int32(mqod.ObjectRecOffset)
-	good.ResponseRecOffset = int32(mqod.ResponseRecOffset)
-
-	good.ObjectRecPtr = mqod.ObjectRecPtr
-	good.ResponseRecPtr = mqod.ResponseRecPtr
+	//good.RecsPresent = int32(mqod.RecsPresent)
+	//good.KnownDestCount = int32(mqod.KnownDestCount)
+	//good.UnknownDestCount = int32(mqod.UnknownDestCount)
+	//good.InvalidDestCount = int32(mqod.InvalidDestCount)
+	//good.ObjectRecPtr = mqod.ObjectRecPtr
+	//good.ResponseRecPtr = mqod.ResponseRecPtr
 
 	for i = 0; i < C.MQ_SECURITY_ID_LENGTH; i++ {
 		good.AlternateSecurityId[i] = (byte)(mqod.AlternateSecurityId[i])

ibmmq/mqiMQPMO.go

@@ -32,21 +32,21 @@ import "C"
 MQPMO is a structure containing the MQ Put MessageOptions (MQPMO)
 */
 type MQPMO struct {
-	Version           int32
-	Options           int32
-	Timeout           int32
-	Context           C.MQHOBJ
-	KnownDestCount    int32
-	UnknownDestCount  int32
-	InvalidDestCount  int32
-	ResolvedQName     string
-	ResolvedQMgrName  string
-	RecsPresent       int32
-	PutMsgRecFields   int32
-	PutMsgRecOffset   int32
-	ResponseRecOffset int32
-	PutMsgRecPtr      C.MQPTR
-	ResponseRecPtr    C.MQPTR
+	Version          int32
+	Options          int32
+	Timeout          int32
+	Context          *MQObject
+	KnownDestCount   int32
+	UnknownDestCount int32
+	InvalidDestCount int32
+	ResolvedQName    string
+	ResolvedQMgrName string
+
+	// TODO: These fields are not currently mapped. The Dist List feature is not
+	// fully supported as Pub/Sub is the recommended approach.
+	//RecsPresent       int32
+	//PutMsgRec   []MQPMR
+	//ResponseRec []MQRR
 
 	OriginalMsgHandle MQMessageHandle
 	NewMsgHandle      MQMessageHandle
@@ -64,18 +64,12 @@ func NewMQPMO() *MQPMO {
 	pmo.Version = int32(C.MQPMO_VERSION_1)
 	pmo.Options = int32(C.MQPMO_NONE)
 	pmo.Timeout = -1
-	pmo.Context = 0
+	pmo.Context = nil
 	pmo.KnownDestCount = 0
 	pmo.UnknownDestCount = 0
 	pmo.InvalidDestCount = 0
 	pmo.ResolvedQName = ""
 	pmo.ResolvedQMgrName = ""
-	pmo.RecsPresent = 0
-	pmo.PutMsgRecFields = 0
-	pmo.PutMsgRecOffset = 0
-	pmo.ResponseRecOffset = 0
-	pmo.PutMsgRecPtr = nil
-	pmo.ResponseRecPtr = nil
 
 	pmo.OriginalMsgHandle.hMsg = C.MQHM_NONE
 	pmo.NewMsgHandle.hMsg = C.MQHM_NONE
@@ -92,20 +86,22 @@ func copyPMOtoC(mqpmo *C.MQPMO, gopmo *MQPMO) {
 
 	mqpmo.Options = C.MQLONG(gopmo.Options) | C.MQPMO_FAIL_IF_QUIESCING
 	mqpmo.Timeout = C.MQLONG(gopmo.Timeout)
-	mqpmo.Context = gopmo.Context
+	if gopmo.Context != nil {
+		mqpmo.Context = gopmo.Context.hObj
+	}
 	mqpmo.KnownDestCount = C.MQLONG(gopmo.KnownDestCount)
 	mqpmo.UnknownDestCount = C.MQLONG(gopmo.UnknownDestCount)
 	mqpmo.InvalidDestCount = C.MQLONG(gopmo.InvalidDestCount)
 
 	setMQIString((*C.char)(&mqpmo.ResolvedQName[0]), gopmo.ResolvedQName, C.MQ_OBJECT_NAME_LENGTH)
 	setMQIString((*C.char)(&mqpmo.ResolvedQMgrName[0]), gopmo.ResolvedQMgrName, C.MQ_OBJECT_NAME_LENGTH)
 
-	mqpmo.RecsPresent = C.MQLONG(gopmo.RecsPresent)
-	mqpmo.PutMsgRecFields = C.MQLONG(gopmo.PutMsgRecFields)
-	mqpmo.PutMsgRecOffset = C.MQLONG(gopmo.PutMsgRecOffset)
-	mqpmo.ResponseRecOffset = C.MQLONG(gopmo.ResponseRecOffset)
-	mqpmo.PutMsgRecPtr = gopmo.PutMsgRecPtr
-	mqpmo.ResponseRecPtr = gopmo.ResponseRecPtr
+	mqpmo.RecsPresent = 0
+	mqpmo.PutMsgRecFields = 0
+	mqpmo.PutMsgRecOffset = 0
+	mqpmo.ResponseRecOffset = 0
+	mqpmo.PutMsgRecPtr = nil
+	mqpmo.ResponseRecPtr = nil
 
 	if gopmo.OriginalMsgHandle.hMsg != C.MQHM_NONE {
 		mqpmo.OriginalMsgHandle = gopmo.OriginalMsgHandle.hMsg
@@ -131,20 +127,20 @@ func copyPMOfromC(mqpmo *C.MQPMO, gopmo *MQPMO) {
 
 	gopmo.Options = int32(mqpmo.Options)
 	gopmo.Timeout = int32(mqpmo.Timeout)
-	gopmo.Context = mqpmo.Context
+	//gopmo.Context = mqpmo.Context // This is input only so don't copy back
 	gopmo.KnownDestCount = int32(mqpmo.KnownDestCount)
 	gopmo.UnknownDestCount = int32(mqpmo.UnknownDestCount)
 	gopmo.InvalidDestCount = int32(mqpmo.InvalidDestCount)
 
 	gopmo.ResolvedQName = trimStringN((*C.char)(&mqpmo.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
 	gopmo.ResolvedQMgrName = trimStringN((*C.char)(&mqpmo.ResolvedQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
 
-	gopmo.RecsPresent = int32(mqpmo.RecsPresent)
-	gopmo.PutMsgRecFields = int32(mqpmo.PutMsgRecFields)
-	gopmo.PutMsgRecOffset = int32(mqpmo.PutMsgRecOffset)
-	gopmo.ResponseRecOffset = int32(mqpmo.ResponseRecOffset)
-	gopmo.PutMsgRecPtr = mqpmo.PutMsgRecPtr
-	gopmo.ResponseRecPtr = mqpmo.ResponseRecPtr
+	//gopmo.RecsPresent = int32(mqpmo.RecsPresent)
+	//gopmo.PutMsgRecFields = int32(mqpmo.PutMsgRecFields)
+	//gopmo.PutMsgRecOffset = int32(mqpmo.PutMsgRecOffset)
+	//gopmo.ResponseRecOffset = int32(mqpmo.ResponseRecOffset)
+	//gopmo.PutMsgRecPtr = mqpmo.PutMsgRecPtr
+	//gopmo.ResponseRecPtr = mqpmo.ResponseRecPtr
 
 	gopmo.OriginalMsgHandle.hMsg = mqpmo.OriginalMsgHandle
 	gopmo.NewMsgHandle.hMsg = mqpmo.NewMsgHandle

mqmetric/discover.go

@@ -98,8 +98,8 @@ const defaultMaxQDepth = 5000
 var Metrics AllMetrics
 
 // Only issue the warning about a '/' in queue name once.
-var globalSlashWarning = false;
-var localSlashWarning = false;
+var globalSlashWarning = false
+var localSlashWarning = false
 
 var qInfoMap map[string]*QInfo
 var locale string
@@ -554,25 +554,25 @@ func discoverQueues(monitoredQueuePatterns string) error {
 		qList, err = inquireObjects(monitoredQueuePatterns, ibmmq.MQOT_Q)
 	}
 
-  localSlashWarning = false
+	localSlashWarning = false
 	if len(qList) > 0 {
 		//fmt.Printf("Monitoring Queues: %v\n", qList)
 		for i := 0; i < len(qList); i++ {
 			var qInfoElem *QInfo
 			var ok bool
 			qName := strings.TrimSpace(qList[i])
 
-      // If the qName contains a '/' - eg "DEV/QUEUE/1" then the queue manager will
+			// If the qName contains a '/' - eg "DEV/QUEUE/1" then the queue manager will
 			// not (right now) process resource publications correctly. Hopefully that will get
 			// fixed at some point, but we will issue a warning here. The same problem happens with
 			// amqsrua; there's no workround possible outside of the qmgr code.
 			//
 			// Because of the possible complexities of pattern matching, we don't
 			// actually fail the discovery process, but instead issue a warning and continue with
 			// other queues.
-			if strings.Contains(qName,"/") && globalSlashWarning == false {
+			if strings.Contains(qName, "/") && globalSlashWarning == false {
 				localSlashWarning = true // First time through, issue the warning for all queues
-				logError("Warning: Cannot subscribe to queue containing '/': %s",qName)
+				logError("Warning: Cannot subscribe to queue containing '/': %s", qName)
 				continue
 			}
 
@@ -749,7 +749,7 @@ func inquireObjects(objectPatternsList string, objectType int32) ([]string, erro
 							for i := 0; i < len(elem.String); i++ {
 								s := strings.TrimSpace(elem.String[i])
 
-								  objectList = append(objectList, s)
+								objectList = append(objectList, s)
 
 							}
 						}

mqmetric/log.go

@@ -45,11 +45,12 @@ func logInfo(format string, v ...interface{}) {
 		logger.Info(format, v...)
 	}
 }
+
 // Errors should be reported always
 func logError(format string, v ...interface{}) {
 	if logger != nil && logger.Error != nil {
 		logger.Error(format, v...)
 	} else {
-		fmt.Printf(format,v...)
+		fmt.Printf(format, v...)
 	}
 }