# Aw::Client

Method | Arguments | Return | Throws Exception
--- | --- | --- | ---
new | ( client_group [, app_name] ) ( broker_host, broker_name, client_id, client_group, app_name [, desc]) The default broker_host and name are used when the args are not passed, the app_name can will be autogenerated from the script name when omitted. | Aw::Client | YES
DESTROY | ( ) | void | NO
acknowledge | ( seqn ) | Boolean | YES
acknowledgeThrough | ( seqn ) | Boolean | YES
beginTransaction | ( transaction_id, required_level, @String ) | Number | YES
canPublish | ( event_type_name ) | Boolean | YES
canSubscribe | ( event_type_name ) | Boolean | YES
cancelCallbackForSubId | ( sub_id ) | Boolean | YES
cancelCallbackForTag | ( tag ) | Boolean | YES
cancelSubscription | ( event_type_name, filter ) | Boolean | YES
cancelSubscriptions | ( @Aw::Subscription ) | Boolean | YES
cancelCallbacks | ( client ) | Boolean | YES
clearQue | ( client ) | Boolean | YES
connect | ( %Configuration ) %Config must contain the 'clientGroup' key and value. Optional keys are brokerHost brokerName clientId applicationName connectionDescriptor The connect method will work like newOrReconnect with error reporting. | Aw::Client | YES
deliver | ( dest_id, [@]Aw::Event ) | Boolean | YES
deliverAckReplyEvent | ( request_event, publish_seqn ) | Boolean | NO
deliverErrorReplyEvent | ( request_event, reply_event ) | Boolean | YES
deliverNullReplyEvent | ( request_event, reply_event_type_name, publish_seqn ) | Boolean | YES
deliverPartialReplyEvents | ( request_event, @Aw::Event ) | Number | YES
deliverReplyEvent | ( request_event, [@]Aw::Event ) | Boolean | YES
deliverReplyEvents | ( request_event, @Aw::Event ) | Number | YES
deliverRequestAndWait | ( dest_id, event, msecs ) | @Aw::Event | YES
disconnect | ( ) | Boolean | YES
dispatch | ( msecs ) | Boolean | YES
doesSubscriptionExist | ( event_type_name, filter ) | Boolean | YES
endTransaction | ( transaction_id, mode ) | Number | YES
getAccessLabel | ( ) | @Ints | YES
getApplicationName | ( ) | String | YES
getBrokerHost | ( ) | String | YES
getBrokerName | ( ) | String | YES
getBrokerPort | ( ) | Number | YES
getCanPublishNames | ( ) | @String | YES
getCanPublishTypeDefs | ( ) | @Aw::TypeDef | YES
getCanSubscribeNames | ( ) | @String | YES
getCanSubscribeTypeDefs | ( ) | @Aw::TypeDef | YES
getClientGroup | ( ) | String | YES
getClientId | ( ) | String | YES
getBrokerSSLCertificate | ( ) | Aw::SSLCertificate | YES
getClientInfoset | ( ) | Aw::Event | YES
getClientLastPublishSequenceNumber | ( ) | CORBA::LongLong | YES
getConnectionDescriptor | ( ) | Aw::ConnectionDescriptor | YES
getDefaultBrokerPort | ( ) | Number | NO
getDefaultClientOut | ( msecs ) | Number | NO
getEvent | ( msecs ) | Aw::Event | YES
getEvents | ( max_events, msecs ) | @Aw::Event | YES
getEventTypeDef | ( event_type_name ) | Aw::TypeDef | YES
getEventTypeDefs | ( event_type_names ) | @Aw::TypeDef | YES
getEventTypeInfosetNames | ( field_name ) | @String | YES
getEventTypeNames | ( field_name ) | @String | YES
getEventsWithAck | ( max_events, msecs, Corba::LongLong ) | @Aw::Event | YES
getFamilyEventTypeNames | ( field_name ) | @String | YES
getFamilyNames | ( ) | @String | YES
getFd | ( ) | Number | YES
getFds | ( ) | @Ints | YES
getPlatformInfo | ( key ) | String | YES
getPlatformInfoKeys | ( ) | @String | YES
getQueueLength | ( ) | Number | YES
getSSLBrokerDistinguishedName | ( ) | String | YES
getSSLBrokerIssuerDistinguishedName | ( ) | String | YES
getSSLEncryptionLevel | ( ) | Number | YES
getScopeEventTypeNames | ( field_name ) | @String | YES
getScopeNames | ( ) | @String | YES
getStateShareLimit | ( ) | Number | YES
getSubscriptions | ( ) | @Aw::Subscription | YES
getTerritoryName | ( ) | String | YES
interruptDispatch | ( ) | Boolean | YES
interruptGetEvents | ( ) | Boolean | YES
isClientPending | ( ) | Boolean | YES
isConnected | ( ) | Boolean | NO
isPending | ( ) | Boolean | YES
mainLoop | ( ) | Boolean | YES
makeSubId | ( ) | Number | NO
makeTag | ( ) | Number | NO
makeTransactionId | ( ) | String | YES
makeUniqueSubId | ( ) | Number | YES
newOrReconnect | ( broker_host, broker_name, client_id, client_group, app_name [, desc] ) ( client_id, client_group [, app_name] ) Arguments work like new. | Aw::Client | YES
newSubscription | ( event_type_name [, filter] ) ( [@]Aw::Subscription ) | Boolean | YES
newSubscriptionFromStruct | ( [@]Aw::Subscription ) | Boolean | YES
newSubscriptionFromStructs | ( @Aw::Subscription ) | Boolean | YES
newSubscriptionWithId | ( sub_id, event_type_name [, filter] ) | Boolean | YES
prime | ( ) | Boolean | YES
primeAllClient | ( ) | Boolean | YES
publish | ( [@]Aw::Event ) | Boolean | YES
publishEvents | ( @Aw::Event ) | Boolean | YES
publishRequestAndWait | ( event, msecs ) | @Aw::Event | YES
reconnect | ( [broker_host, broker_name, ] client_id ) The default broker_host and broker_name are used when omitted. | Aw::Client | YES
registerCallback | ( method ) | Boolean | YES
registerCallbackForSubId | ( sub_id, method, client_data ) | Boolean | YES
registerCallbackForTag | ( tag, cancel_when_done, method, client_data ) | Boolean | YES
registerConnectionCallback | ( method, data ) | Boolean | YES
setClientAutomaticControlLabel | ( enabled ) | Boolean | YES
setClientInfoset | ( @Aw::Event ) | Boolean | YES
setPlatformInfo | ( event_type_name, filter ) | Boolean | YES
setStateShareLimit | ( limit ) | Boolean | YES
stopMainLoop | ( ) | Boolean | YES
threadedCallBacks | ( enabled ) | Boolean | YES
toString | ( ) | String | NO
Inherited Methods
err | ( ) | Boolean | YES
errmsg | ( ) | String | YES
error | ( ) | Aw::Error | NO
hello | ( ) Returns the string "hello". Useful for debugging. | String | NO
getWarn | ( ) Returns current warn `level`. | Number | NO
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. | void | NO
warn | ( [string] ) Warn message is `string` if passed, otherwise current err is converted to string. | void | YES