BrokerLost class: Difference between revisions
Created page with "<!-- BrokerLost class --> __NOTOC__ The <var>BrokerLost</var> exception class indicates that the connection with the <var class="product">Imagine Transparency</var> broker for the session was lost, either because of a network issue or an error in the <var class="product">Imagine</var> application. The <var>Call</var> function of the <var>Imagine</var> system class is currently the only method that might throw a <var>BrokerLo..." |
No edit summary |
||
Line 12: | Line 12: | ||
<li>[[BrokerLost methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class.</li> | <li>[[BrokerLost methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class.</li> | ||
</ul> | </ul> | ||
==New constructor== | |||
{{Template:DaemonLost:New subtitle}} | |||
This <var>Constructor</var> generates an instance of a <var>[[DaemonLost_class|DaemonLost]]</var> exception. As shown below, the optional argument of the <var>New</var> method is a setting of the <var>[[DaemonOutput_(DaemonLost_property)|DaemonOutput]]</var> property. | |||
===Syntax=== | |||
{{Template:BrokerLost:New syntax}} | |||
====Syntax terms==== | |||
<table> | |||
<tr><th>%brokerLost</th> | |||
<td>A reference to an instance of a <var>BrokerLost</var> object. | |||
</td></tr> | |||
<tr><th><var>[%(BrokerLost):]</var></th> | |||
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>.</td></tr> |
Revision as of 16:00, 25 March 2025
The BrokerLost exception class indicates that the connection with the Imagine Transparency broker for the session was lost, either because of a network issue or an error in the Imagine application.
The Call function of the Imagine system class is currently the only method that might throw a BrokerLost exception. For more information about catching a thrown exception, see Try and Catch. A lost broker connection for Imagine Transparency file operations results in a request cancellation as there's typically no method to throw the exception and, even if an exception were thrown in such a case, the error is so low-level and severe that any attempt to recover from it would be a bad idea.
The BrokerLost methods
The following are the available BrokerLost class methods.
Method | Description |
---|---|
New | Create a new BrokerLost object |
The methods in the class are described in the subsections that follow. In addition:
- Notation conventions for methods has information about the conventions followed.
- BrokerLost methods syntax is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new DaemonLost object (DaemonLost class)
This Constructor generates an instance of a DaemonLost exception. As shown below, the optional argument of the New method is a setting of the DaemonOutput property.
Syntax
%brokerLost = [%(BrokerLost):]New
Syntax terms
%brokerLost | A reference to an instance of a BrokerLost object. |
---|---|
[%(BrokerLost):] | The class name in parentheses denotes a Constructor. |