Object methods (public)

void operator = ( const ImqChannel & channel );

Copies instance data from channel, replacing any existing instance data.

MQLONG batchHeartBeat( ) const ;

Returns the batch heart-beat.

ImqBoolean setBatchHeartBeat( const MQLONG heartbeat = 0L );

Sets the batch heart-beat . This method returns TRUE if successful.

ImqString channelName( ) const ;

Returns the channel name.

ImqBoolean setChannelName( const char * name = 0 );

Sets the channel name. This method returns TRUE if successful.

ImqString connectionName( ) const ;

Returns the connection name.

ImqBoolean setConnectionName( const char * name = 0 );

Sets the connection name. This method returns TRUE if successful.

size_t headerCompressionCount( ) const ;

Returns the supported header data compression techniques count.

ImqBoolean headerCompression( const size_t count, MQLONG compress [ ] ) const ;

Returns copies of the supported header data compression techniques in compress. This method returns TRUE if successful.

ImqBoolean setHeaderCompression( const size_t count, const MQLONG compress [ ] );

Sets the supported header data compression techniques to compress.

Sets the supported header data compression techniques count to count.

This method returns TRUE if successful.

MQLONG heartBeatInterval( ) const ;

Returns the heart-beat interval.

ImqBoolean setHeartBeatInterval( const MQLONG interval = 300L );

Sets the heart-beat interval. This method returns TRUE if successful.

MQLONG keepAliveInterval( ) const ;

Returns the keep alive interval.

ImqBoolean setKeepAliveInterval( const MQLONG interval = MQKAI_AUTO );

Sets the keep alive interval. This method returns TRUE if successful.

ImqString localAddress() const ;

Returns the local address.

ImqBoolean setLocalAddress ( const char * address = 0 );

Sets the local address. This method returns TRUE if successful.

MQLONG maximumMessageLength( ) const ;

Returns the maximum message length.

ImqBoolean setMaximumMessageLength( const MQLONG length = 4194304L );

Sets the maximum message length. This method returns TRUE if successful.

size_t messageCompressionCount( ) const ;

Returns the supported message data compression techniques count.

ImqBoolean messageCompression( const size_t count, MQLONG compress [ ]) const ;

Returns copies of the supported message data compression techniques in compress. This method returns TRUE if successful.

ImqBoolean setMessageCompression( const size_t count, const MQLONG compress [ ] );

Sets the supported message data compression techniques to compress.

Sets the supported message data compression techniques count to count.

This method returns TRUE if successful.

ImqString modeName( ) const ;

Returns the mode name.

ImqBoolean setModeName( const char * name = 0 );

Sets the mode name. This method returns TRUE if successful.

ImqString password( ) const ;

Returns the password.

ImqBoolean setPassword( const char * password = 0 );

Sets the password. This method returns TRUE if successful.

size_t receiveExitCount( ) const ;

Returns the receive exit count.

ImqString receiveExitName( );

Returns the first of the receive exit names, if any. If the receive exit count is zero, it returns an empty string.

ImqBoolean receiveExitNames( const size_t count, ImqString * names [ ] );

Returns copies of the receive exit names in names. Sets any names in excess of receive exit count to null strings. This method returns TRUE if successful.

ImqBoolean setReceiveExitName( const char * name = 0 );

Sets the receive exit names to the single name. name can be blank or null. Sets the receive exit count to either 1 or zero. Clears the receive user data. This method returns TRUE if successful.

ImqBoolean setReceiveExitNames( const size_t count, const char * names [ ] );

Sets the receive exit names to names. Individual names values must not be blank or null. Sets the receive exit count to count. Clears the receive user data. This method returns TRUE if successful.

ImqBoolean setReceiveExitNames( const size_t count, const ImqString * names [ ] );

Sets the receive exit names to names. Individual names values must not be blank or null. Sets the receive exit count to count. Clears the receive user data. This method returns TRUE if successful.

ImqString receiveUserData( );

Returns the first of the receive user data items, if any. If the receive exit count is zero, returns an empty string.

ImqBoolean receiveUserData( const size_t count, ImqString * data [ ] );

Returns copies of the receive user data items in data. Sets any data in excess of receive exit count to null strings. This method returns TRUE if successful.

ImqBoolean setReceiveUserData( const char * data = 0 );

Sets the receive user data to the single item data. If data is not null, receive exit count must be at least 1. This method returns TRUE if successful.

ImqBoolean setReceiveUserData( const size_t count, const char * data [ ] );

Sets the receive user data to data. count must be no greater than the receive exit count. This method returns TRUE if successful.

ImqBoolean setReceiveUserData( const size_t count, const ImqString * data [ ] );

Sets the receive user data to data. count must be no greater than the receive exit count. This method returns TRUE if successful.

ImqString securityExitName( ) const ;

Returns the security exit name.

ImqBoolean setSecurityExitName( const char * name = 0 );

Sets the security exit name. This method returns TRUE if successful.

ImqString securityUserData( ) const ;

Returns the security user data.

ImqBoolean setSecurityUserData( const char * data = 0 );

Sets the security user data. This method returns TRUE if successful.

size_t sendExitCount( ) const ;

Returns the send exit count.

ImqString sendExitName( );

Returns the first of the send exit names, if any. Returns an empty string if the send exit count is zero.

ImqBoolean sendExitNames( const size_t count, ImqString * names [ ] );

Returns copies of the send exit names in names. Sets any names in excess of send exit count to null strings. This method returns TRUE if successful.

ImqBoolean setSendExitName( const char * name = 0 );

Sets the send exit names to the single name. name can be blank or null. Sets the send exit count to either 1 or zero. Clears the send user data. This method returns TRUE if successful

ImqBoolean setSendExitNames( const size_t count, const char * names [ ] );

Sets the send exit names to names. Individual names values must not be blank or null. Sets the send exit count to count. Clears the send user data. This method returns TRUE if successful.

ImqBoolean setSendExitNames( const size_t count, const ImqString * names [ ] );

Sets the send exit names to names. Individual names values must not be blank or null. Sets the send exit count to count. Clears the send user data. This method returns TRUE if successful.

ImqString sendUserData( );

Returns the first of the send user data items, if any. , Returns an empty string if the send exit count is zero.

ImqBoolean sendUserData( const size_t count, ImqString * data [ ] );

Returns copies of the send user data items in data. Sets any data in excess of send exit count to null strings. This method returns TRUE if successful.

ImqBoolean setSendUserData( const char * data = 0 );

Sets the send user data to the single item data. If data is not null, send exit count must be at least 1. This method returns TRUE if successful.

ImqBoolean setSendUserData( const size_t count, const char * data [ ] );

Sets the send user data to data. count must be no greater than the send exit count. This method returns TRUE if successful.

ImqBoolean setSendUserData( const size_t count, const ImqString * data [ ] );

Sets the send user data to data. count must be no greater than the send exit count. This method returns TRUE if successful.

ImqString sslCipherSpecification( ) const ;

Returns the SSL cipher specification.

ImqBoolean setSslCipherSpecification( const char * name = 0 );

Sets the SSL cipher specification. This method returns TRUE if successful.

MQLONG sslClientAuthentication( ) const ;

Returns the SSL client authentication type.

ImqBoolean setSslClientAuthentication( const MQLONG auth = MQSCA_REQUIRED);

Sets the SSL client authentication type. This method returns TRUE if successful.

ImqString sslPeerName( ) const ;

Returns the SSL peer name.

ImqBoolean setSslPeerName( const char * name = 0 );

Sets the SSL peer name. This method returns TRUE if successful.

ImqString transactionProgramName( ) const ;

Returns the transaction program name.

ImqBoolean setTransactionProgramName( const char * name = 0 );

Sets the transaction program name. This method returns TRUE if successful.

MQLONG transportType( ) const ;

Returns the transport type.

ImqBoolean setTransportType( const MQLONG type = MQXPT_LU62 );

Sets the transport type. This method returns TRUE if successful.

ImqString userId( ) const ;

Returns the user id.

ImqBoolean setUserId( const char * id = 0 );

Sets the user id. This method returns TRUE if successful.

ImqBoolean hdrCompList( const MQLONG compress [ ] );

Returns the list of supported header data compression techniques in compress. This method returns TRUE if successful.

ImqBoolean setHdrCompList( const MQLONG compress [ ] );

Sets the list of supported header data compression techniques. This method returns TRUE if successful.

size_t msgCompListCount( ) const ;

Returns the length of the supported message data compression technique list.

ImqBoolean msgCompList( const size_t count, const MQLONG compress [ ] );

Returns the list of supported message data compression techniques in compress. This method returns TRUE if successful.

ImqBoolean setMsgCompList( const size_t count, const MQLONG compress [ ] );

Sets the list of supported message data compression techniques. Sets the length of the supported message data compression technique list to count. This method returns TRUE if successful.