Aw::Client

MethodArgumentsReturnThrows
Exception
new( broker_host, broker_name, client_id, client_group, app_name [, desc])Aw::ClientYES
DESTROY( )voidNO
acknowledge( seqn )BooleanYES
acknowledgeThrough( seqn )BooleanYES
beginTransaction( transaction_id, required_level, @String )NumberYES
canPublish( event_type_name )BooleanYES
canSubscribe( event_type_name )BooleanYES
cancelCallbackForSubId( sub_id )BooleanYES
cancelCallbackForTag( tag )BooleanYES
cancelSubscription( event_type_name, filter )BooleanYES
cancelSubscriptions( @Aw::Subscription )BooleanYES
cancelCallbacks( client )BooleanYES
clearQue( client )BooleanYES
connect( %Configuration )
%Config must contain the 'clientGroup' key and value. Optional keys arebrokerHost
brokerName
clientId
applicationName
connectionDescriptor
The connect method will work like newOrReconnect with error reporting.
Aw::ClientYES
deliver( dest_id, [@]Aw::Event )BooleanYES
deliverAckReplyEvent( request_event, publish_seqn )BooleanNO
deliverErrorReplyEvent( request_event, reply_event )BooleanYES
deliverNullReplyEvent( request_event, reply_event_type_name, publish_seqn )BooleanYES
deliverPartialReplyEvents( request_event, @Aw::Event )NumberYES
deliverReplyEvent( request_event, [@]Aw::Event )BooleanYES
deliverReplyEvents( request_event, @Aw::Event )NumberYES
deliverRequestAndWait( dest_id, event, msecs )@Aw::EventYES
disconnect( )BooleanYES
dispatch( msecs )BooleanYES
doesSubscriptionExist( event_type_name, filter )BooleanYES
endTransaction( transaction_id, mode )NumberYES
getAccessLabel( )@IntsYES
getApplicationName( )StringYES
getBrokerHost( )StringYES
getBrokerName( )StringYES
getBrokerPort( )NumberYES
getCanPublishNames( )@StringYES
getCanPublishTypeDefs( )@Aw::TypeDefYES
getCanSubscribeNames( )@StringYES
getCanSubscribeTypeDefs( )@Aw::TypeDefYES
getClientGroup( )StringYES
getClientId( )StringYES
getBrokerSSLCertificate( )Aw::SSLCertificateYES
getClientInfoset( )Aw::EventYES
getClientLastPublishSequenceNumber( )CORBA::LongLongYES
getConnectionDescriptor( )Aw::ConnectionDescriptorYES
getDefaultBrokerPort( )NumberNO
getDefaultClientOut( msecs )NumberNO
getEvent( msecs )Aw::EventYES
getEvents( max_events, msecs )@Aw::EventYES
getEventTypeDef( event_type_name )Aw::TypeDefYES
getEventTypeDefs( event_type_names )@Aw::TypeDefYES
getEventTypeInfosetNames( field_name )@StringYES
getEventTypeNames( field_name )@StringYES
getEventsWithAck( max_events, msecs, Corba::LongLong )@Aw::EventYES
getFamilyEventTypeNames( field_name )@StringYES
getFamilyNames( )@StringYES
getFd( )NumberYES
getFds( )@IntsYES
getPlatformInfo( key )StringYES
getPlatformInfoKeys( )@StringYES
getQueueLength( )NumberYES
getSSLBrokerDistinguishedName( )StringYES
getSSLBrokerIssuerDistinguishedName( )StringYES
getSSLEncryptionLevel( )NumberYES
getScopeEventTypeNames( field_name )@StringYES
getScopeNames( )@StringYES
getStateShareLimit( )NumberYES
getSubscriptions( )@Aw::SubscriptionYES
getTerritoryName( )StringYES
interruptDispatch( )BooleanYES
interruptGetEvents( )BooleanYES
isClientPending( )BooleanYES
isConnected( )BooleanNO
isPending( )BooleanYES
mainLoop( )BooleanYES
makeSubId( )NumberNO
makeTag( )NumberNO
makeTransactionId( )StringYES
makeUniqueSubId( )NumberYES
newEZ( client_group [, app_name] )Aw::ClientYES
newOrReconnect( broker_host, broker_name, client_id, client_group, app_name [, desc] )Aw::ClientYES
newOrReconnectEZ( client_id, client_group [, app_name] )Aw::ClientYES
newSubscription( event_type_name [, filter] )
( [@]Aw::Subscription )
BooleanYES
newSubscriptionFromStruct( [@]Aw::Subscription )BooleanYES
newSubscriptionFromStructs( @Aw::Subscription )BooleanYES
newSubscriptionWithId( sub_id, event_type_name [, filter] )BooleanYES
prime( )BooleanYES
primeAllClient( )BooleanYES
publish( [@]Aw::Event )BooleanYES
publishEvents( @Aw::Event )BooleanYES
publishRequestAndWait( event, msecs )@Aw::EventYES
reconnect( broker_host, broker_name, client_id )Aw::ClientYES
reconnectEZ( client_id )Aw::ClientYES
registerCallback( method )BooleanYES
registerCallbackForSubId( sub_id, method, client_data )BooleanYES
registerCallbackForTag( tag, cancel_when_done, method, client_data )BooleanYES
registerConnectionCallback( method, data )BooleanYES
setClientAutomaticControlLabel( enabled )BooleanYES
setClientInfoset( @Aw::Event )BooleanYES
setPlatformInfo( event_type_name, filter )BooleanYES
setStateShareLimit( limit )BooleanYES
stopMainLoop( )BooleanYES
threadedCallBacks( enabled )BooleanYES
toString( )StringNO
Inherited Methods
err( )BooleanYES
errmsg( )StringYES
error( )Aw::ErrorNO
hello( )
Returns the string "hello". Useful for debugging.
StringNO
getWarn( )
Returns current warn level.
NumberNO
setWarn( level )
Sets new warn level.0 : No warnings (quiet mode)
1 : Terse (uses awErrorToString)
2 : Verbose (uses awErrorToCompleteString)
The Aw extensions must be compiled with AWXS_WARNS defined.
voidNO
warn( [string] )
Warn message is string if passed, otherwise current err is converted to string.
voidYES