net.rim.device.api.io
Interface DatagramStatusListener

public interface DatagramStatusListener

Describes functionality that a datagram status listener must implement.

If you plan on using datagram status listeners then you should invoke DatagramConnectionBase.allocateDatagramId(javax.microedition.io.Datagram) and use this value when invoking DatagramBase.setDatagramId(int). This value will then be the datagram ID returned in the callback. Use it to determine what datagram the event is for.

Since:

JDE 4.0.0

Field Summary

static int	ACKNOWLEDGED Datagram's receipt has been acknowleged.
static int	CANCELLED Generic cancellation error.
static int	COMP_ENCRYPT Datagram is currently being compressed/encrypted.
static int	CPPDEV_BEGIN Lowest possible value for transmission errors specific to C++ devices.
static int	CPPDEV_END Highest possible value for transmission errors specific to C++ devices.
static int	CPPDEV_VALID_MASK Valid event mask.
static int	DELIVERED Datagram has been delivered.
static int	ERROR Generic error.
static int	ERROR_APN Access point name error.
static int	ERROR_FDN_FAILURE SMS sending error: FDN vailure.
static int	ERROR_FLAG Some kind of error has occured.
static int	ERROR_GENERAL SMS delivery error: general.
static int	ERROR_INVALID_SC_ADDR SMS sending error: datagram has invalid SC address.
static int	ERROR_MAX_ATTEMPTS MDP error: maximum number of attempts reached.
static int	ERROR_NETWORK SMS delivery error: network failure.
static int	ERROR_ORIG_DENIED SMS delivery error: originator denied.
static int	ERROR_PACKET_ADDRESS Packet addressing error.
static int	ERROR_PACKET_CONGESTED Congested packet error.
static int	ERROR_PACKET_EXPIRED Expired packet error.
static int	ERROR_PACKET_FAILURE Failed packet error.
static int	ERROR_PACKET_FATAL Fatal packet error.
static int	ERROR_PACKET_FORMAT Packet formatting error.
static int	ERROR_PACKET_RESEND_LATER Resend packet later error.
static int	ERROR_PACKET_RETURNED Packet returned error.
static int	ERROR_PORT_REG Port registration error.
static int	ERROR_RADIO_SEND Radio sending error.
static int	ERROR_REFUSED MDP error: datagram refused.
static int	ERROR_SERVICE_NOT_AVAILABLE SMS delivery error: Service not available.
static int	ERROR_TERM_DENIED SMS delivery error: terminator denied.
static int	ERROR_TOO_LONG SMS delivery error: datagram too long.
static int	ERROR_TRANSMITTER Transmitter error.
static int	ERROR_UNKNOWN_DEST SMS delivery error: datagram has unkown destination.
static int	ERROR_UNSUPPORTED SMS delivery error: service not supported.
static int	ERROR_VERSION MDP error: bad version.
static int	FETCHING_KEY Compressor/encryptor is currently fetching key.
static int	GME_COMP_ALG_UNDECIDED GME error: compression algorithm undecided.
static int	GME_ENCRYPT_ALG_UNDECIDED GME error: encryption algorithm undecided.
static int	GME_ENCRYPT_COMP_FAILURE GME error: encryption/compression failure.
static int	GME_MALFORMED_ADDRESS GME error: malformed address.
static int	GME_MISMATCHED_DACS GME error: mismatched DACs.
static int	GME_NO_COMP_MODE_AVAILABLE GME error: no compression mode available.
static int	GME_NO_CRYPTO_MODE_AVAILABLE GME error: no cryptography mode available.
static int	GME_NO_DAC_FOUND GME error: no DAC found.
static int	GME_NO_ROUTING_INFORMATION GME error: no routing information.
static int	GME_NO_SERVICE_DEFINED GME error: no service defined.
static int	GME_SERVICE_DISABLED GME error: service disabled.
static int	GME_TERROR_BAD_GME_FORMAT GME transaction error: bad GME format.
static int	GME_TERROR_DECRYPTION_ERROR GME transaction error: decryption error.
static int	GME_TERROR_FAILURE_AT_SERVICE GME transaction error: failure at service.
static int	GME_TERROR_GENERAL_FAILURE GME transaction error: general failure.
static int	GME_TERROR_INVALID_SERVICE_IDENTIFIER GME transaction error: invalid service identifier.
static int	GME_TERROR_RESERVED GME transaction error: reserved.
static int	GME_TERROR_TIMEOUT GME transaction error: timeout.
static int	GME_TERROR_UNHANDLED_GME_CMD GME transaction error: unhandled GME command.
static int	GME_UNKNOWN_DESTINATION GME error: unknown desintation.
static long	GUID_GME_CRYPTO_FAILURE The GUID for the global event sent when the date changes.
static int	IPPP_RECEIVED_CLOSED IPPP event: received and closed.
static int	IPPP_RECEIVED_CLOSING IPPP event: received and closing.
static int	IPPP_RECEIVED_DATA IPPP event: received data.
static int	IPPP_RECEIVED_ERROR IPPP event: reception error.
static int	MAILBOXED Datagram has been mailboxed.
static int	NO_ERROR No error.
static int	PENDING Datagram is pending transmission.
static int	SENDING Datagram is currently transmitting.
static int	SENT Datagram sent.
static int	SENTINEL Sentinel value (should never actually be passed as an event).

Method Summary

void	updateDatagramStatus(int dgId, int code, Object context) Invoked when a datagram's status changes.

Field Detail

GUID_GME_CRYPTO_FAILURE

public static final long GUID_GME_CRYPTO_FAILURE

The GUID for the global event sent when the date changes.

Since:

JDE 4.0.0

SENTINEL

public static final int SENTINEL

Sentinel value (should never actually be passed as an event).

Since:

JDE 4.0.0

SENT

public static final int SENT

Datagram sent.

Since:

JDE 4.0.0

PENDING

public static final int PENDING

Datagram is pending transmission.

Since:

JDE 4.0.0

SENDING

public static final int SENDING

Datagram is currently transmitting.

Since:

JDE 4.0.0

COMP_ENCRYPT

public static final int COMP_ENCRYPT

Datagram is currently being compressed/encrypted.

Since:

JDE 4.0.0

FETCHING_KEY

public static final int FETCHING_KEY

Compressor/encryptor is currently fetching key.

Since:

JDE 4.0.0

DELIVERED

public static final int DELIVERED

Datagram has been delivered.

Note: The DELIVERED event code has a context object. The context object is an array of Strings. Each String will be a destination address that has confirmed delivery of the datagram. If an address is not listed, that address has not confirmed delivery.

Since:

JDE 4.0.0

ACKNOWLEDGED

public static final int ACKNOWLEDGED

Datagram's receipt has been acknowleged.

Since:

JDE 4.0.0

MAILBOXED

public static final int MAILBOXED

Datagram has been mailboxed.

Since:

JDE 4.0.0

NO_ERROR

public static final int NO_ERROR

No error.

Since:

JDE 4.0.0

ERROR_FLAG

public static final int ERROR_FLAG

Some kind of error has occured.

This flag is ORed with another value indicating the precise error that occured.

Since:

JDE 4.0.0

ERROR

public static final int ERROR

Generic error.

Since:

JDE 4.0.0

CANCELLED

public static final int CANCELLED

Generic cancellation error.

Since:

JDE 4.0.0

ERROR_PACKET_FATAL

public static final int ERROR_PACKET_FATAL

Fatal packet error.

Since:

JDE 4.0.0

ERROR_PACKET_FORMAT

public static final int ERROR_PACKET_FORMAT

Packet formatting error.

Since:

JDE 4.0.0

ERROR_RADIO_SEND

public static final int ERROR_RADIO_SEND

Radio sending error.

Since:

JDE 4.0.0

ERROR_APN

public static final int ERROR_APN

Access point name error.

Since:

JDE 4.0.0

ERROR_TRANSMITTER

public static final int ERROR_TRANSMITTER

Transmitter error.

Since:

JDE 4.0.0

ERROR_PORT_REG

public static final int ERROR_PORT_REG

Port registration error.

Since:

JDE 4.0.0

ERROR_PACKET_ADDRESS

public static final int ERROR_PACKET_ADDRESS

Packet addressing error.

Since:

JDE 4.0.0

ERROR_PACKET_CONGESTED

public static final int ERROR_PACKET_CONGESTED

Congested packet error.

Since:

JDE 4.0.0

ERROR_PACKET_EXPIRED

public static final int ERROR_PACKET_EXPIRED

Expired packet error.

Since:

JDE 4.0.0

ERROR_PACKET_FAILURE

public static final int ERROR_PACKET_FAILURE

Failed packet error.

Since:

JDE 4.0.0

ERROR_PACKET_RESEND_LATER

public static final int ERROR_PACKET_RESEND_LATER

Resend packet later error.

Since:

JDE 4.0.0

ERROR_PACKET_RETURNED

public static final int ERROR_PACKET_RETURNED

Packet returned error.

Since:

JDE 4.0.0

ERROR_NETWORK

public static final int ERROR_NETWORK

SMS delivery error: network failure.

Since:

JDE 4.0.0

ERROR_GENERAL

public static final int ERROR_GENERAL

SMS delivery error: general.

Since:

JDE 4.0.0

ERROR_ORIG_DENIED

public static final int ERROR_ORIG_DENIED

SMS delivery error: originator denied.

Since:

JDE 4.0.0

ERROR_TERM_DENIED

public static final int ERROR_TERM_DENIED

SMS delivery error: terminator denied.

Since:

JDE 4.0.0

ERROR_UNSUPPORTED

public static final int ERROR_UNSUPPORTED

SMS delivery error: service not supported.

Since:

JDE 4.0.0

ERROR_TOO_LONG

public static final int ERROR_TOO_LONG

SMS delivery error: datagram too long.

Since:

JDE 4.0.0

ERROR_UNKNOWN_DEST

public static final int ERROR_UNKNOWN_DEST

SMS delivery error: datagram has unkown destination.

Since:

JDE 4.0.0

ERROR_SERVICE_NOT_AVAILABLE

public static final int ERROR_SERVICE_NOT_AVAILABLE

SMS delivery error: Service not available.

Since:

JDE 4.0.0

ERROR_INVALID_SC_ADDR

public static final int ERROR_INVALID_SC_ADDR

SMS sending error: datagram has invalid SC address.

Since:

JDE 4.0.0

ERROR_FDN_FAILURE

public static final int ERROR_FDN_FAILURE

SMS sending error: FDN vailure.

Since:

JDE 4.0.0

ERROR_MAX_ATTEMPTS

public static final int ERROR_MAX_ATTEMPTS

MDP error: maximum number of attempts reached.

Since:

JDE 4.0.0

ERROR_REFUSED

public static final int ERROR_REFUSED

MDP error: datagram refused.

Since:

JDE 4.0.0

ERROR_VERSION

public static final int ERROR_VERSION

MDP error: bad version.

Since:

JDE 4.0.0

GME_MALFORMED_ADDRESS

public static final int GME_MALFORMED_ADDRESS

GME error: malformed address.

Since:

JDE 4.0.0

GME_NO_ROUTING_INFORMATION

public static final int GME_NO_ROUTING_INFORMATION

GME error: no routing information.

Since:

JDE 4.0.0

GME_SERVICE_DISABLED

public static final int GME_SERVICE_DISABLED

GME error: service disabled.

Since:

JDE 4.0.0

GME_MISMATCHED_DACS

public static final int GME_MISMATCHED_DACS

GME error: mismatched DACs.

Since:

JDE 4.0.0

GME_NO_SERVICE_DEFINED

public static final int GME_NO_SERVICE_DEFINED

GME error: no service defined.

Since:

JDE 4.0.0

GME_UNKNOWN_DESTINATION

public static final int GME_UNKNOWN_DESTINATION

GME error: unknown desintation.

Since:

JDE 4.0.0

GME_NO_COMP_MODE_AVAILABLE

public static final int GME_NO_COMP_MODE_AVAILABLE

GME error: no compression mode available.

Since:

JDE 4.0.0

GME_NO_CRYPTO_MODE_AVAILABLE

public static final int GME_NO_CRYPTO_MODE_AVAILABLE

GME error: no cryptography mode available.

Since:

JDE 4.0.0

GME_NO_DAC_FOUND

public static final int GME_NO_DAC_FOUND

GME error: no DAC found.

Since:

JDE 4.0.0

GME_ENCRYPT_ALG_UNDECIDED

public static final int GME_ENCRYPT_ALG_UNDECIDED

GME error: encryption algorithm undecided.

Since:

JDE 4.0.0

GME_COMP_ALG_UNDECIDED

public static final int GME_COMP_ALG_UNDECIDED

GME error: compression algorithm undecided.

Since:

JDE 4.0.0

GME_ENCRYPT_COMP_FAILURE

public static final int GME_ENCRYPT_COMP_FAILURE

GME error: encryption/compression failure.

Since:

JDE 4.0.0

GME_TERROR_RESERVED

public static final int GME_TERROR_RESERVED

GME transaction error: reserved. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_FAILURE_AT_SERVICE

public static final int GME_TERROR_FAILURE_AT_SERVICE

GME transaction error: failure at service. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_UNHANDLED_GME_CMD

public static final int GME_TERROR_UNHANDLED_GME_CMD

GME transaction error: unhandled GME command. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_BAD_GME_FORMAT

public static final int GME_TERROR_BAD_GME_FORMAT

GME transaction error: bad GME format. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_TIMEOUT

public static final int GME_TERROR_TIMEOUT

GME transaction error: timeout. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_INVALID_SERVICE_IDENTIFIER

public static final int GME_TERROR_INVALID_SERVICE_IDENTIFIER

GME transaction error: invalid service identifier. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_DECRYPTION_ERROR

public static final int GME_TERROR_DECRYPTION_ERROR

GME transaction error: decryption error. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

GME_TERROR_GENERAL_FAILURE

public static final int GME_TERROR_GENERAL_FAILURE

GME transaction error: general failure. This error may pass up a String object for context containing a human readable description of the failure.

Since:

JDE 4.0.0

IPPP_RECEIVED_DATA

public static final int IPPP_RECEIVED_DATA

IPPP event: received data.

Since:

JDE 4.0.0

IPPP_RECEIVED_CLOSING

public static final int IPPP_RECEIVED_CLOSING

IPPP event: received and closing.

Since:

JDE 4.0.0

IPPP_RECEIVED_CLOSED

public static final int IPPP_RECEIVED_CLOSED

IPPP event: received and closed.

Since:

JDE 4.0.0

IPPP_RECEIVED_ERROR

public static final int IPPP_RECEIVED_ERROR

IPPP event: reception error.

Since:

JDE 4.0.0

CPPDEV_BEGIN

public static final int CPPDEV_BEGIN

Lowest possible value for transmission errors specific to C++ devices.

Since:

JDE 4.0.0

CPPDEV_END

public static final int CPPDEV_END

Highest possible value for transmission errors specific to C++ devices.

Since:

JDE 4.0.0

CPPDEV_VALID_MASK

public static final int CPPDEV_VALID_MASK

Valid event mask.

Mask for removing garbage data in top byte after ERROR_FLAG is found not to be one.

Since:

JDE 4.0.0

Method Detail

updateDatagramStatus

public void updateDatagramStatus(int dgId,
                                 int code,
                                 Object context)

Invoked when a datagram's status changes.

Parameters:

dgId - The ID of the datagram.

code - an integer that represents the new status value

context - Some kind of context object (may be null). Depends on the event code received

Since:

JDE 4.0.0