View source for CoordinatorException class

The <var>CoordinatorException</var> exception class indicates that a two-phase commit coordinator has returned an error.
 
The <var>[[NewGlobal (Transaction function)|NewGlobal]]</var> function and <var>[[SetGlobal (Transaction subroutine)|SetGlobal]]</var> of the <var>[[Transaction class|Transaction]]</var> system classes are method that can throw a <var>CoordinatorException</var> exception. For more information about catching a thrown exception, see [[Exceptions#Try and Catch|Try and Catch]].
 
The following example shows a <var>Try</var> and <var>Catch</var> of a <var>CoordinatorException</var> exception. 
<p class="code">begin
   %xid    is string len 64
   %coex   is object coordinatorException
   try 
      %xid = %(transaction):NewGlobal("Silly example transaction")
   catch coordinatorException to %coex
      [[PrintText statement|printText]] NewGlobal failed:
      printText {%coex:reason}: {%coex:description}   
      stop                                            
   end try
   ...
end
</p>
<b>Note:</b> It is necessary to declare the exception object, but instantiating it is taken care of by the <var>[[Transaction class|Transaction]]</var> class <var>[[NewGlobal (Transaction function)|NewGlobal]]</var> method.
 
==The CoordinatorException methods==
{{Template:List of CoordinatorException methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods]] has information about the conventions followed. </li> 
<li>[[CoordinatorException methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
</ul>

==Description property==
{{Template:CoordinatorException:Description subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a string that describes the error.

===Syntax===
{{Template:CoordinatorException:Description syntax}}

====Syntax terms====
<table>
<tr><th>%string</th>
<td>This describes the error.
</td></tr>

<tr><th>coordinatorException</th>
<td>A reference to an instance of a <var>[[CoordinatorException_class|CoordinatorException]]</var> object.
</td></tr></table>

==New constructor==
{{Template:CoordinatorException:New subtitle}}

This <var>Constructor</var> generates an instance of a <var>[[CoordinatorException_class|CoordinatorException]]</var> exception.  As shown below, the optional argument of the <var>New</var> method is a setting of the <var>[[DaemonOutput_(CoordinatorException_property)|DaemonOutput]]</var> property.

===Syntax===
{{Template:CoordinatorException:New syntax}}

====Syntax terms====
<table>
<tr><th>%coordinatorException</th>
<td>A reference to an instance of a <var>CoordinatorException</var> object.
</td></tr>

<tr><th><var>[%(CoordinatorException):]</var></th>
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>.</td></tr>

<tr><th><var>CoordinatorExceptionReason</var></th>
<td>This optional, but [[Methods#Named parameters|name required]], parameter specifies a <var>CoordinatorExceptionReason</var> value that indicates the error.
</td></tr>

<tr><th><var>Description</var></th>
<td>This optional, but [[Methods#Named parameters|name required]], parameter specifies a string that describes the error.
</td></tr>

</table>

==Reason property==
{{Template:CoordinatorException:Reason subtitle}}

This <var>[[Classes and Objects#readWrite|ReadOnly]]</var> property returns a <var>CoordinatorExceptionReason</var> enumeration value that indicates the error.

===Syntax===
{{Template:CoordinatorException:Reason syntax}}

====Syntax terms====
<table>
<tr><th>%soordinatorExceptionReason</th>
<td>Enumeration value that indicates the error.
</td></tr>

<tr><th>coordinatorException</th>
<td>A reference to an instance of a <var>[[CoordinatorException_class|CoordinatorException]]</var> object.
</td></tr></table>

<h1 id="reason">CoordinatorExceptionReason enumeration</h1>
A <var>CoordinatorExceptionReason</var> [[Enumerations|enumeration]] may have one of the following values:
<table class="thJustBold">
<tr><th>ConnectionLost</th>
<td>The connection with the coordinator was lost after it was established. This could be indicative of a compatibility issue between Model 204 and the coordinator.</td></tr>
<tr><th>InsufficientVirtualStorage</th>
<td>There was insufficient virtual storage to allocate the blocks needed to connect to the coordinator.</td></tr>
<tr><th>InvalidResponse</th>
<td>an invalid response to a request was received from the coordinator. This could be indicative of a compatibility issue between Model 204 and the coordinator.</td></tr>
<tr><th>MaximumConnectionsExceeded</th>
<td>The maximum authorized Janus or Janus Two-Phase Commit connections are in use.</td></tr> 
<tr><th>NameLookupError</th>
<td>The host name specified in an <var>ADDCOORDINATOR</var> could not be resolved because of a DNS error.</td></tr>
<tr><th>NameUnresolved</th>
<td>The host name specified in an <var>ADDCOORDINATOR</var> could not be located via DNS.</td></tr>
<tr><th>NoneAvailable</th>
<td>There are either no 2PC ports defined or the first started 2PC port has no coordinators added to it.</td></tr>
<tr><th>NoPortConnectionsAvailable</th>
<td>The maximum connections specified for the 2PC port are all in use.</td></tr>
<tr><th>TlsHandshakeError</th>
<td>The TLS handshake with the coordinator specified in an <var>ADDCOORDINATOR</var> failed.</td></tr>
<tr><th>Unreachable</th>
<td>It was not possible to connect to the coordinator host/port specified in an <var>ADDCOORDINATOR</var>.</td></tr>
</table>

[[Category:System exception classes]]