<html>
<head>
<title>Aw::Client</title>
</head>
<body bgcolor="#f0f0f0" link="#cc0000" vlink="brown">
<h1><u>Aw::Client</u></h1>
<table width="90%" border=1 bgcolor="#cccc99">
<tr bgcolor="#bfbfbf"><th>Method</th><th>Arguments</th><th>Return</th><th>Throws<br>Exception</th></tr>
<tr align="center"><th align="left"><a name="new"></a>new</th><td>( client_group [, app_name] )<br>( broker_host, broker_name, client_id, client_group, app_name [, desc])<hr width="90%" noshade align="left"><font size=-1><div align="left">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.</div></font></td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="DESTROY"></a>DESTROY</th><td>( )</td><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="acknowledge"></a>acknowledge</th><td>( seqn )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="acknowledgeThrough"></a>acknowledgeThrough</th><td>( seqn )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="beginTransaction"></a>beginTransaction</th><td>( transaction_id, required_level, @String )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="canPublish"></a>canPublish</th><td>( event_type_name )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="canSubscribe"></a>canSubscribe</th><td>( event_type_name )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="cancelCallbackForSubId"></a>cancelCallbackForSubId</th><td>( sub_id )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="cancelCallbackForTag"></a>cancelCallbackForTag</th><td>( tag )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="cancelSubscription"></a>cancelSubscription</th><td>( event_type_name, filter )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="cancelSubscriptions"></a>cancelSubscriptions</th><td>( @Aw::Subscription )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="cancelCallbacks"></a>cancelCallbacks</th><td>( client )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="clearQue"></a>clearQue</th><td>( client )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left" valign="top"><a name="connect"></a>connect</th><td>( %Configuration )<hr width="90%" noshade align="left"><font size=-1><div align="left">%Config must contain the 'clientGroup' key and value. Optional keys are<dir>brokerHost<br>brokerName<br>clientId<br>applicationName<br>connectionDescriptor</dir>The connect method will work like newOrReconnect with error reporting.</div></font></td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliver"></a>deliver</th><td>( dest_id, [@]Aw::Event )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverAckReplyEvent"></a>deliverAckReplyEvent</th><td>( request_event, publish_seqn )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="deliverErrorReplyEvent"></a>deliverErrorReplyEvent</th><td>( request_event, reply_event )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverNullReplyEvent"></a>deliverNullReplyEvent</th><td>( request_event, reply_event_type_name, publish_seqn )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverPartialReplyEvents"></a>deliverPartialReplyEvents</th><td>( request_event, @Aw::Event )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverReplyEvent"></a>deliverReplyEvent</th><td>( request_event, [@]Aw::Event )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverReplyEvents"></a>deliverReplyEvents</th><td>( request_event, @Aw::Event )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverRequestAndWait"></a>deliverRequestAndWait</th><td>( dest_id, event, msecs )</td><td>@Aw::Event</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="disconnect"></a>disconnect</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="dispatch"></a>dispatch</th><td>( msecs )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="doesSubscriptionExist"></a>doesSubscriptionExist</th><td>( event_type_name, filter )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="endTransaction"></a>endTransaction</th><td>( transaction_id, mode )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getAccessLabel"></a>getAccessLabel</th><td>( )</td><td>@Ints</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getApplicationName"></a>getApplicationName</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getBrokerHost"></a>getBrokerHost</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getBrokerName"></a>getBrokerName</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getBrokerPort"></a>getBrokerPort</th><td>( )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getCanPublishNames"></a>getCanPublishNames</th><td>( )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getCanPublishTypeDefs"></a>getCanPublishTypeDefs</th><td>( )</td><td>@Aw::TypeDef</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getCanSubscribeNames"></a>getCanSubscribeNames</th><td>( )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getCanSubscribeTypeDefs"></a>getCanSubscribeTypeDefs</th><td>( )</td><td>@Aw::TypeDef</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getClientGroup"></a>getClientGroup</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getClientId"></a>getClientId</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getBrokerSSLCertificate"></a>getBrokerSSLCertificate</th><td>( )</td><td>Aw::SSLCertificate</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getClientInfoset"></a>getClientInfoset</th><td>( )</td><td>Aw::Event</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getClientLastPublishSequenceNumber"></a>getClientLastPublishSequenceNumber</th><td>( )</td><td>CORBA::LongLong</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getConnectionDescriptor"></a>getConnectionDescriptor</th><td>( )</td><td>Aw::ConnectionDescriptor</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getDefaultBrokerPort"></a>getDefaultBrokerPort</th><td>( )</td><td>Number</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getDefaultClientTimeOut"></a>getDefaultClientOut</th><td>( msecs )</td><td>Number</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getEvent"></a>getEvent</th><td>( msecs )</td><td>Aw::Event</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEvents"></a>getEvents</th><td>( max_events, msecs )</td><td>@Aw::Event</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEventTypeDef"></a>getEventTypeDef</th><td>( event_type_name )</td><td>Aw::TypeDef</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEventTypeDefs"></a>getEventTypeDefs</th><td>( event_type_names )</td><td>@Aw::TypeDef</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEventTypeInfosetNames"></a>getEventTypeInfosetNames</th><td>( field_name )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEventTypeNames"></a>getEventTypeNames</th><td>( field_name )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEventsWithAck"></a>getEventsWithAck</th><td>( max_events, msecs, Corba::LongLong )</td><td>@Aw::Event</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getFamilyEventTypeNames"></a>getFamilyEventTypeNames</th><td>( field_name )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getFamilyNames"></a>getFamilyNames</th><td>( )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getFd"></a>getFd</th><td>( )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getFds"></a>getFds</th><td>( )</td><td>@Ints</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getPlatformInfo"></a>getPlatformInfo</th><td>( key )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getPlatformInfoKeys"></a>getPlatformInfoKeys</th><td>( )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getQueueLength"></a>getQueueLength</th><td>( )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getSSLBrokerDistinguishedName"></a>getSSLBrokerDistinguishedName</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getSSLBrokerIssuerDistinguishedName"></a>getSSLBrokerIssuerDistinguishedName</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getSSLEncryptionLevel"></a>getSSLEncryptionLevel</th><td>( )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getScopeEventTypeNames"></a>getScopeEventTypeNames</th><td>( field_name )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getScopeNames"></a>getScopeNames</th><td>( )</td><td>@String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getStateShareLimit"></a>getStateShareLimit</th><td>( )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getSubscriptions"></a>getSubscriptions</th><td>( )</td><td>@Aw::Subscription</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getTerritoryName"></a>getTerritoryName</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="interruptDispatch"></a>interruptDispatch</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="interruptGetEvents"></a>interruptGetEvents</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="isClientPending"></a>isClientPending</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="isConnected"></a>isConnected</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="isPending"></a>isPending</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="mainLoop"></a>mainLoop</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="makeSubId"></a>makeSubId</th><td>( )</td><td>Number</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="makeTag"></a>makeTag</th><td>( )</td><td>Number</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="makeTransactionId"></a>makeTransactionId</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="makeUniqueSubId"></a>makeUniqueSubId</th><td>( )</td><td>Number</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="newOrReconnect"></a>newOrReconnect</th><td>( broker_host, broker_name, client_id, client_group, app_name [, desc] )<br>( client_id, client_group [, app_name] )<hr width="90%" noshade align="left"><font size=-1><div align="left">Arguments work like <a href="#new">new.</a></div></font></td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="newSubscription"></a>newSubscription</th><td>( event_type_name [, filter] )<br>( [@]Aw::Subscription )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="newSubscriptionFromStruct"></a>newSubscriptionFromStruct</th><td>( [@]Aw::Subscription )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="newSubscriptionFromStructs"></a>newSubscriptionFromStructs</th><td>( @Aw::Subscription )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="newSubscriptionWithId"></a>newSubscriptionWithId</th><td>( sub_id, event_type_name [, filter] )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="prime"></a>prime</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="primeAllClients"></a>primeAllClient</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="publish"></a>publish</th><td>( [@]Aw::Event )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="publishEvents"></a>publishEvents</th><td>( @Aw::Event )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="publishRequestAndWait"></a>publishRequestAndWait</th><td>( event, msecs )</td><td>@Aw::Event</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="reconnect"></a>reconnect</th><td>( [broker_host, broker_name, ] client_id )<hr width="90%" noshade align="left"><font size=-1><div align="left">The default broker_host and broker_name are used when omitted.</div></font></td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="registerCallback"></a>registerCallback</th><td>( method )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="registerCallbackForSubId"></a>registerCallbackForSubId</th><td>( sub_id, method, client_data )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="registerCallbackForTag"></a>registerCallbackForTag</th><td>( tag, cancel_when_done, method, client_data )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="registerConnectionCallback"></a>registerConnectionCallback</th><td>( method, data )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="setClientAutomaticControlLabel"></a>setClientAutomaticControlLabel</th><td>( enabled )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="setClientInfoset"></a>setClientInfoset</th><td>( @Aw::Event )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="setPlatformInfo"></a>setPlatformInfo</th><td>( event_type_name, filter )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="setStateShareLimit"></a>setStateShareLimit</th><td>( limit )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="stopMainLoop"></a>stopMainLoop</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="threadedCallBacks"></a>threadedCallBacks</th><td>( enabled )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="toString"></a>toString</th><td>( )</td><td>String</td><td>NO</td></tr>
<tr bgcolor="#bfbfbf" align="left"><th colspan=4>Inherited Methods</th></tr>
<tr align="center"><th align="left"><a name="err"></a>err</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="errmsg"></a>errmsg</th><td>( )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="error"></a>error</th><td>( )</td><td>Aw::Error</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="hello"></a>hello</th><td>( )<br><div align="left">Returns the string "hello". Useful for debugging.</div></td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getWarn"></a>getWarn</th><td>( )<br><div align="left">Returns current warn <b><code>level</code></b>.</div></th><td>Number</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="setWarn"></a>setWarn</th><td>( level )<br><div align="left">Sets new warn <b><code>level</code></b>.<dir>0 : No warnings (quiet mode)<br>1 : Terse (uses awErrorToString)<br>2 : Verbose (uses awErrorToCompleteString)</dir>The Aw extensions must be compiled with AWXS_WARNS defined.</div></th><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="warn"></a>warn</th><td>( [string] )<br><div align="left">Warn message is <b><code>string</code></b> if passed, otherwise current err is converted to string.</div></th><td>void</td><td>YES</td></tr>
</table>
<p><hr size=3 noshade>
</body>
</html>