|
MigratoryData Client API for PHP
Developer's Guide and Reference Manual
|
Define the error codes of the API, and their corresponding error texts and error causes. More...
Public Member Functions | |
| int | getCode () |
| Get the error code. More... | |
| String | getCause () |
| Get the error cause. More... | |
| String | getDetail () |
| Get the error text. More... | |
Public Attributes | |
| int | E_INVALID_SUBJECT = 1 |
| Indicate an invalid subject syntax. More... | |
| int | E_TRANSPORT_INIT_FAILED = 2 |
| Indicate a transport initialization failure. More... | |
| int | E_CONNECTION_FAILED = 3 |
| Indicate a connection failure. More... | |
| int | E_MSG_NULL = 4 |
| Indicate that the message supplied for delivery is null. More... | |
| int | E_MSG_INVALID = 5 |
| Indicate that the message supplied for delivery is invalid. More... | |
| int | E_MSG_FIELD_INVALID = 6 |
| Indicate that the message supplied for delivery has an invalid field. More... | |
| int | E_CLUSTER_MEMBERS_CONNECTION_FAILED = 7 |
| Indicate that the client failed to connect to all MigratoryData servers in the cluster. More... | |
| int | E_INVALID_URL_LIST = 8 |
| Indicate an invalid list of MigratoryData servers. More... | |
| int | E_INVALID_URL = 9 |
| Indicate an invalid address for a MigratoryData server. More... | |
| int | E_INVALID_PROTOCOL = 10 |
| Indicate an internal error during communication with a MigratoryData server. More... | |
| int | E_ENTITLEMENT_TOKEN = 11 |
| Indicate that the entitlement token was not supplied. More... | |
Define the error codes of the API, and their corresponding error texts and error causes.
| int MigratoryDataException.getCode | ( | ) |
Get the error code.
| String MigratoryDataException.getCause | ( | ) |
Get the error cause.
| String MigratoryDataException.getDetail | ( | ) |
Get the error text.
| int MigratoryDataException.E_INVALID_SUBJECT = 1 |
Indicate an invalid subject syntax.
This error code indicates that the subject used to build a new message has an invalid syntax.
The corresponding error cause contains the invalid subject itself.
| int MigratoryDataException.E_TRANSPORT_INIT_FAILED = 2 |
Indicate a transport initialization failure.
This error code indicates that the client was not able to establish the transport connection to a MigratoryData server.
The corresponding error cause contains the address of the MigratoryData server to which the client failed to establish the trasport connection.
| int MigratoryDataException.E_CONNECTION_FAILED = 3 |
Indicate a connection failure.
This error code indicates that the client was not able to connect to a MigratoryData server.
The corresponding error cause contains the address of the MigratoryData server to which the client failed to connect.
| int MigratoryDataException.E_MSG_NULL = 4 |
Indicate that the message supplied for delivery is null.
The message supplied for delivery is null
| int MigratoryDataException.E_MSG_INVALID = 5 |
Indicate that the message supplied for delivery is invalid.
The message supplied for delivery is invalid.
| int MigratoryDataException.E_MSG_FIELD_INVALID = 6 |
Indicate that the message supplied for delivery has an invalid field.
The message supplied for delivery has an invalid field.
| int MigratoryDataException.E_CLUSTER_MEMBERS_CONNECTION_FAILED = 7 |
Indicate that the client failed to connect to all MigratoryData servers in the cluster.
The client failed to connect to all MigratoryData servers in the cluster.
| int MigratoryDataException.E_INVALID_URL_LIST = 8 |
Indicate an invalid list of MigratoryData servers.
The list of MigratoryData servers is incorrectly specified.
| int MigratoryDataException.E_INVALID_URL = 9 |
Indicate an invalid address for a MigratoryData server.
The address of a MigratoryData server is incorrectly specified.
| int MigratoryDataException.E_INVALID_PROTOCOL = 10 |
Indicate an internal error during communication with a MigratoryData server.
Internal communication error.
| int MigratoryDataException.E_ENTITLEMENT_TOKEN = 11 |
Indicate that the entitlement token was not supplied.
Use the method MigratoryDataClient.setEntitlementToken() to define an entitement token.