<html>
<head>
<title>Aw::Adapter</title>
</head>
<body bgcolor="#f0f0f0" link="#cc0000" vlink="brown">
<h1><u>Aw::Adapter</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>( [ @Strings ] )<br>( [ Aw::Properties ] )</td><td>Aw::Adapter</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="addEvent"></a>addEvent</th><td>( event )</td><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="checkPublications"></a>checkPublications</th><td>( )</td><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="connectTest"></a>connectTest</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="createAdapterClient"></a>createAdapterClient</th><td>( stateShare )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="createClient"></a>createClient</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="deliverErrorEvent"></a>deliverErrorEvent</th><td>( category, msgId, @Strings )</td><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="destroyClient"></a>destroyClient</th><td>( )<br><div align="right">disconnects and destroys the adapter's broker client if present</div></td><td>void</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="eventDef"></a>eventDef</th><td>( )</td><td>Aw::EventType</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getAdapterEventName"></a>getAdapterEventName</th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getAdapterInfo"></a>getAdapterInfo</th><td>( )</td><td>Aw::Event</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getAdapterType"></a>getAdapterType<br> <font size=-1>adapterType</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getAdapterVersion"></a>getAdapterVersion<br> <font size=-1>adapterVersion</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getAdminClient"></a>getAdminClient</th><td>( )</td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getBroker"></a>getBroker<br> <font size=-1>brokerClient</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getBrokerClient"></a>getBrokerClient</th><td>( )</td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getBrokerHost"></a>getBrokerHost<br> <font size=-1>brokerHost</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getBrokerName"></a>getBrokerName<br> <font size=-1>brokerName</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getClient"></a>getClient</th><td>( )</td><td>Aw::Client</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getClientGroup"></a>getClientGroup<br> <font size=-1>clientGroup</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getClientId"></a>getClientId<br> <font size=-1>clientId</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getClientName"></a>getClientName<br> <font size=-1>clientName</font></th><td>( )</td><td>String</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getEventDefs"></a>getEventDefs<br> <font size=-1>eventDefs</font></th><td>( )</td><td>@Aw::EventType</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEvents"></a>getEvents</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getEventDef"></a>getEventDef</th><td>( name )</td><td>Aw::EventType</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getPublishWaitTime"></a>getPublishWaitTime</th><td>( )</td><td>Number</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="init"></a>init</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="initStatusSubscriptions"></a>initStatusSubscriptions</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="isConnectTest"></a>isConnectTest</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="isEventFieldSet"></a>isEventFieldSet</th><td>( event, field_name )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="isMaster"></a>isMaster</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="loadProperties"></a>loadProperties</th><td>( @Strings )</td><td>Aw::Properties</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="newSubscription"></a>newSubscription</th><td>( event_type_name, filter, [ [requestEvent], [requestDef] ] )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="publishStatus"></a>publishStatus</th><td>( )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="removeEvent"></a>removeEvent</th><td>( event_name )</td><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="requestEvent"></a>requestEvent</th><td>( )</td><td>Aw::Event</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="setConnectionDescriptorSSL"></a>setConnectionDescriptorSSL</th><td>( desc )</td><td>Boolean</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="setEventField"></a>setEventField</th><td>(event, field_name, typeDef, value)</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="setStatusProperty"></a>setStatusProperty</th><td>( propertyName )</td><td>void</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="verifyLicense"></a>verifyLicense</th><td>( licenseKeyPrefix )</td><td>void</td><td>NO</td></tr>
<tr><td colspan=4 bgcolor="#bfbfbf" align="center"><strong><i>methods requiring an AdapterHandle are accessible from Aw::Adapter</i></strong></td></tr>
<tr align="center"><th align="left"><a name="createEvent"></a>createEvent</th><td>( name )</td><td>Aw::Event</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="createTypedEvent"></a>createTypedEvent</th><td>( name )</td><td>Aw::Event</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="deliverAckReplyEvent"></a>deliverAckReplyEvent</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="deliverNullReplyEvent"></a>deliverNullReplyEvent</th><td>( )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="deliverPartialReplyEvent"></a>deliverPartialReplyEvent</th><td>( replyEvent, record, isLast, replyToken )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="deliverReplyEvent"></a>deliverReplyEvent</th><td>( event )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="getEventTypeDef"></a>getEventTypeDef</th><td>( event_name )</td><td>Aw::TypeDef</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="getStringField"></a>getStringField</th><td>( field_name )</td><td>String</td><td>YES</td></tr>
<tr align="center"><th align="left"><a name="publish"></a>publish</th><td>( event )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="setFieldFromString"></a>setFieldFromString</th><td>( event, field_name, typeDef, value )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="setStringField"></a>setStringField</th><td>( event, fieldName, value )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="setupEventVerify"></a>setupEventVerify</th><td>( canSubscribe, canPublish, supportsNotification )</td><td>Boolean</td><td>NO</td></tr>
<tr align="center"><th align="left"><a name="toFormattedString"></a>toFormattedString</th><td>( format )</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>