Difference between revisions of "SHIPHarbour:DataTypes:ErrorCode"

Latest revision as of 19:00, 31 July 2017

Description

Appears in all SHIPHarbour requests, used for validating if a requested operation worked and diagnosing failures.

NONE

No error has occurred. Default value in sent messages.

PARSE

The message could not be parsed.

VERSION

An unknown or unexpected version was detected.

IGNORED

The message could not be handled, but did not cause any side-effects.

PARAM_GENERIC

The parameters in a Generic message were incorrect.

PARAM_ROUTINE

The parameters in a Routine message were incorrect.

PARAM_BRIDGE

The parameters in a low-level SHIPBridge message were incorrect.

NO_ENDPOINT

The specified Endpoint could not be found.

NO_ROUTINE

The specified Routine could not be found.

BUSY

New connections or messages could not be processed.

INTERNAL

SHIPHarbour Master has had an internal error.

TIMEOUT

SHIPHarbour Master has waited too long for a response from an Endpoint or the client.

ABORTED

Requested operation was forcibly canceled, typically due to disconnected of the target Endpoint.

BRIDGE

Requested operation cannot be completed due to an error in the low-level SHIPBridge protocol.

ALTERNATIVE

Requested operation could not be performed at this time, but an alternative method is available.

BLOCKED

Requested operation is not available at this time, but may become available later.

FORBIDDEN

Requested operation is not allowed on this Endpoint, this indicates a SHIPBridge restriction.

@@ Line 1: / Line 1: @@
-==Coming Soon==
+== Description ==
-This page is currently under construction. If you need immediate help with this topic, please contact [https://www.seriousintegrated.com/contact Serious Support].
+<onlyinclude>Appears in all SHIPHarbour requests, used for validating if a requested operation worked and diagnosing failures.</onlyinclude>
+=== NONE ===
+No error has occurred. Default value in sent messages.
+=== PARSE ===
+The message could not be parsed.
+=== VERSION ===
+An unknown or unexpected version was detected.
+=== IGNORED ===
+The message could not be handled, but did not cause any side-effects.
+=== PARAM_GENERIC ===
+The parameters in a [[SHIPHarbour:Generic|Generic]] message were incorrect.
+=== PARAM_ROUTINE ===
+The parameters in a [[SHIPHarbour:Generic:Routine|Routine]] message were incorrect.
+=== PARAM_BRIDGE ===
+The parameters in a low-level [[Protocol:SHIPBridge|SHIPBridge]] message were incorrect.
+=== NO_ENDPOINT ===
+The specified [[SHIPHarbour:DataTypes:Endpoint|Endpoint]] could not be found.
-Thank you for your patience.
+=== NO_ROUTINE ===
+The specified [[SHIPHarbour:Generic:Routine|Routine]] could not be found.
-[[Category:NoIndex]]
+=== BUSY ===
-[[Category:UnderConstruction]]
+New connections or messages could not be processed.
-== Description ==
+=== INTERNAL ===
-<onlyinclude>Appears in all SHIPHarbour requests, used for validating if a requested operation worked and diagnosing failures.</onlyinclude>
+SHIPHarbour Master has had an internal error.
+=== TIMEOUT ===
+SHIPHarbour Master has waited too long for a response from an [[SHIPHarbour:DataTypes:Endpoint|Endpoint]] or the client.
+=== ABORTED ===
+Requested operation was forcibly canceled, typically due to disconnected of the target [[SHIPHarbour:DataTypes:Endpoint|Endpoint]].
+=== BRIDGE ===
+Requested operation cannot be completed due to an error in the low-level [[Protocol:SHIPBridge|SHIPBridge]] protocol.
+=== ALTERNATIVE ===
+Requested operation could not be performed at this time, but an alternative method is available.
+=== BLOCKED ===
+Requested operation is not available at this time, but may become available later.
+=== FORBIDDEN ===
+Requested operation is not allowed on this [[SHIPHarbour:DataTypes:Endpoint|Endpoint]], this indicates a [[Protocol:SHIPBridge|SHIPBridge]] restriction.