ImqGetMessageOptions Classe C++

Questa classe incapsula la struttura dati MQGMO

Figura 1. ImqGetMessageOptions classe
Un diagramma di classe di Booch che mostra la classe ImqGetMessageOptions e la sua classe madre, ImqError.

Attributi oggetto

stato del gruppo
Stato di un messaggio per un gruppo di messaggi. Il valore iniziale è MQGS_NOT_IN_GROUP. Sono possibili i seguenti valori aggiuntivi:
  • MQGS_MSG_IN_GROUP
  • MQGS_LAST_MSG_IN_GROUP
opzioni di corrispondenza
Opzioni per selezionare i messaggi in arrivo. Il valore iniziale è MQMO_MATCH | MQMO_MATCH_CORREL_ID. Sono possibili i seguenti valori aggiuntivi:
  • ID_GROUP_MQMO
  • NUMERO SEQ MQMO_MATCH_MSG_
  • MQMO_MATCH_OFFSET
  • MQMO_MSG_TOKEN
  • MQMO_NONE
token del messaggio
Token messaggio. Un valore binario (MQBYTE16) di lunghezza MQ_MSG_TOKEN_LENGTH. Il valore iniziale è MQMTOK_NONE.
Opzioni
Opzioni applicabili a un messaggio. Il valore iniziale è MQGMO_NO_WAIT. Sono possibili i seguenti valori aggiuntivi:
  • MQGMO_WAIT
  • SYNCPOINT MQGMO
  • MQGMO_SYNCPOINT_IF_PERSISTENT
  • MQGMO_NO_SYNCPOINT
  • MQGMO_MARK_SKIP_BACKOUT
  • MQGMO_BROWSE_FIRST
  • MQGMO_BROWSE_SUCCESSIVO
  • MQGMO_BROWSE_MSG_UNDER_CURSOR
  • MQGMO_MSG_UNDER_CURSOR
  • LOCK_MQGMO
  • MQGMO_UNLOCK
  • MQGMO_ACCEPT_TRUNCATED_MSG
  • MQGMO_SET_SIGNAL
  • MQGMO_FAIL_IF_QUIESCING
  • MQGMO_CONVERT
  • ORDER LOGICAL_MQGMO_
  • MQGMO_COMPLETE_MSG
  • MQGMO_ALL_MSGS_AVAILABLE
  • MQGMO_ALL_SEGMENTS_AVAILABLE
  • MQGMO_NONE
Nome coda risolto
Nome coda risolto. Questo attributo è di sola lettura. I nomi non sono mai più lunghi di 48 caratteri e possono essere riempiti con valori null. Il valore iniziale è una stringa null.
lunghezza restituita
Lunghezza restituita. Il valore iniziale è MQRL_UNDEFINED. Questo attributo è di sola lettura.
segmentazione
La capacità di segmentare un messaggio. Il valore iniziale è MQSEG_INIITED. È possibile utilizzare il valore aggiuntivo MQSEG_ALLOWED.
stato segmento
Lo stato di segmentazione di un messaggio. Il valore iniziale è MQSS_NOT_A_SEGMENT. Sono possibili i seguenti valori aggiuntivi:
  • ISCRIZIONE MQSS_SEGMENT
  • ISCRIZIONE MQSS_LAST_SEGMENT
partecipazione punto di sincronizzazione
TRUE quando i messaggi vengono richiamati sotto il controllo del punto di sincronizzazione.
intervallo di attesa
Il periodo di tempo in cui il metodo get della classe viene sospeso durante l'attesa dell'arrivo di un messaggio adatto, se non è già disponibile. Il valore iniziale è zero, che influisce su un'attesa indefinita. Il valore aggiuntivo, MQWI_UNLIMITED, è possibile. Questo attributo viene ignorato a meno che le opzioni non includano MQGMO_WAIT.

Costruttori

ImqGetMessageOptions( );
Il costruttore predefinito.
ImqGetMessageOptions( const ImqGetMessageOptions & gmo );
Il costruttore di copia.

Metodi oggetto (pubblico)

void operator = ( const ImqGetMessageOptions & gmo );
Copia i dati dell'istanza da gmo, sostituendo i dati dell'istanza esistenti.
MQCHAR groupStatus () const ;
Restituisce lo stato del gruppo.
vuoto setGroupStatus ( const MQCHAR status );
Imposta lo stato del gruppo.
MQLONG matchOptions () const ;
Restituisce le opzioni di corrispondenza.
vuoto setMatchOptions ( const MQLONG options );
Imposta le opzioni di corrispondenza.
ImqBinary messageToken( ) const;
Restituisce il token del messaggio.
ImqBoolean setMessageToken( const ImqBinary & token );
Imposta il token messaggio. La lunghezza dati del token deve essere zero o MQ_MSG_TOKEN_LENGTH. Questo metodo restituisce TRUE se ha esito positivo.
void setMessageToken( const MQBYTE16 token = 0 );
Imposta il token messaggio. token può essere zero, che equivale a specificare MQMTOK_NONE. Se token è diverso da zero, deve indirizzare i byte MQ_MSG_TOKEN_LENGTH di dati binari.

Quando si utilizzano valori predefiniti, come ad esempio MQMTOK_NONE, potrebbe non essere necessario eseguire un cast per garantire una corrispondenza della firma, ad esempio (MQBYTE *) MQMTOK_NONE.

MQLONG opzioni () const ;
Restituisce le opzioni.
void setOptions ( const MQLONG opzioni );
Imposta le opzioni, incluso il valore partecipazione del punto di sincronizzazione .
ImqStringresolvedQueueName ( ) const ;
Restituisce una copia del nome coda risolto.
MQLONG returnedLength( ) const;
Restituisce la lunghezza restituita.
MQCHAR segmentazione () const ;
Restituisce la segmentazione.
void setSegmentation ( const MQCHAR valore );
Imposta la segmentazione.
MQCHAR segmentStatus () const ;
Restituisce lo stato del segmento.
vuoto setSegmentStatus ( const MQCHAR status );
Imposta lo stato del segmento.
ImqBooleansyncPointParticipation ( ) const ;
Restituisce il valore partecipazione syncpoint , che è TRUE se le opzioni includono MQGMO_SYNCPOINT o MQGMO_SYNCPOINT_IF_PERSISTENT.
vuoto setSyncPointParticipation ( const ImqBoolean sync );
Imposta il valore partecipazione punto di sincronizzazione . Se sync è TRUE, modifica le opzioni per includere MQGMO_SYNCPOINT e per escludere sia MQGMO_NO_SYNCPOINT che MQGMO_SYNCPOINT_IF_PERSISTENT. Se sync è FALSE, modifica le opzioni per includere MQGMO_NO_SYNCPOINT e per escludere sia MQGMO_SYNCPOINT che MQGMO_SYNCPOINT_IF_PERSISTENT.
MQLONG waitInterval () const ;
Restituisce l' intervallo di attesa.
vuoto setWaitInterval ( const MQLONG intervallo );
Imposta l' intervallo di attesa.

Metodi oggetto (protetti)

vuoto statico setVersionSupported ( const MQLONG );
Imposta la versione MQGMO . Il valore predefinito è MQGMO_VERSION_3.

Dati oggetto (protetti)

MQGMO mese
Una struttura dati MQGMO Versione 2. Accedere ai campi MQGMO supportati solo per MQGMO_VERSION_2 .
PMQGMO mese
L'indirizzo di una struttura dati MQGMO. Il numero di versione per questo indirizzo è indicato in olVersion. Esaminare il numero di versione prima di accedere ai campi MQGMO, per assicurarsi che siano presenti.
MQLONG olVersion
Il numero di versione della struttura dati MQGMO indicato da opgmo.

Codici di origine

  • MQRC_BINARY_DATA_LENGTH_ERROR