SHOW Signed

net.rim.device.api.system
Class MobitexPacketHeader

java.lang.Object
  |
  +--net.rim.device.api.system.MobitexPacketHeader
All Implemented Interfaces:
RadioPacketHeader

public final class MobitexPacketHeader
extends Object
implements RadioPacketHeader

A RadioPacketHeader for sending Mobitex packets.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.0.0

Field Summary
 Category: Signed static int FLAG_MAILBOX
          Mailbox flag.
 Category: Signed static int FLAG_POSACK
          POSACK flag.
 Category: Signed static int FLAG_SENDLIST
          SENDLIST flag.
 Category: Signed static int FLAG_UNKNOWN
          UNKNOWN flag.
 Category: Signed static int PACKET_TYPE_DATA
          Data packet type.
 Category: Signed static int PACKET_TYPE_HPDATA
          HPDATA packet type.
 Category: Signed static int PACKET_TYPE_STATUS
          Status packet type.
 Category: Signed static int PACKET_TYPE_TEXT
          Text packet type.
 Category: Signed static int TS_CANNOT_BE_REACHED
          Returned, cannot be reached.
 Category: Signed static int TS_DESTINATION_BUSY
          Returned, destination busy.
 Category: Signed static int TS_ILLEGAL_MESSAGE
          Returned, bad message format.
 Category: Signed static int TS_MESSAGE_FROM_MAILBOX
          Message from mailbox.
 Category: Signed static int TS_MESSAGE_IN_MAILBOX
          Message was placed in mailbox & copy returned.
 Category: Signed static int TS_MESSAGE_OK
          Message ok.
 Category: Signed static int TS_NETWORK_CONGESTED
          Returned, network congested.
 Category: Signed static int TS_TECHNICAL_ERROR
          Returned, technical network error.
 
Constructor Summary
 Category: Signed MobitexPacketHeader()
          Construct a new MobitexPacketHeader object.
 
Method Summary
 Category: Signed  int getDestinationAddress()
          Retrieves the packet destination address.
 Category: Signed  int getHPID()
          Retrieves the higher protocol ID.
 Category: Signed static int getMaxPacketSize()
          Retrieves the maximum packet size.
 Category: Signed  int getPacketFlags()
          Retrieves the set of packet flags.
 Category: Signed  int getPacketType()
          Retrieves the packet type.
 Category: Signed  int getSourceAddress()
          Retrieves the packet source address.
 Category: Signed  int getTrafficState()
          Retrieves the traffic state.
 Category: Signed  void reset()
          Resets this header.
 Category: Signed  void setDestinationAddress(int destinationAddress)
          Sets the packet destination address.
 Category: Signed  void setHPID(int hpid)
          Sets the higher protocol ID.
 Category: Signed  void setPacketFlags(int packetFlags)
          Sets specified packet flags.
 Category: Signed  void setPacketType(int packetType)
          Sets the packet type.
 Category: Signed  void setSourceAddress(int sourceAddress)
          Sets the packet source address.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TS_MESSAGE_OK

public static final int TS_MESSAGE_OK
Message ok.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_MESSAGE_FROM_MAILBOX

public static final int TS_MESSAGE_FROM_MAILBOX
Message from mailbox.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_MESSAGE_IN_MAILBOX

public static final int TS_MESSAGE_IN_MAILBOX
Message was placed in mailbox & copy returned.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_CANNOT_BE_REACHED

public static final int TS_CANNOT_BE_REACHED
Returned, cannot be reached.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_ILLEGAL_MESSAGE

public static final int TS_ILLEGAL_MESSAGE
Returned, bad message format.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_NETWORK_CONGESTED

public static final int TS_NETWORK_CONGESTED
Returned, network congested.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_TECHNICAL_ERROR

public static final int TS_TECHNICAL_ERROR
Returned, technical network error.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

TS_DESTINATION_BUSY

public static final int TS_DESTINATION_BUSY
Returned, destination busy.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PACKET_TYPE_TEXT

public static final int PACKET_TYPE_TEXT
Text packet type.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PACKET_TYPE_DATA

public static final int PACKET_TYPE_DATA
Data packet type.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PACKET_TYPE_STATUS

public static final int PACKET_TYPE_STATUS
Status packet type.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

PACKET_TYPE_HPDATA

public static final int PACKET_TYPE_HPDATA
HPDATA packet type.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FLAG_MAILBOX

public static final int FLAG_MAILBOX
Mailbox flag.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FLAG_POSACK

public static final int FLAG_POSACK
POSACK flag.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FLAG_SENDLIST

public static final int FLAG_SENDLIST
SENDLIST flag.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

FLAG_UNKNOWN

public static final int FLAG_UNKNOWN
UNKNOWN flag.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Constructor Detail

MobitexPacketHeader

public MobitexPacketHeader()
Construct a new MobitexPacketHeader object.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

reset

public void reset()
Resets this header.

Use this method to reset this header's information fields to their default values.

Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setSourceAddress

public void setSourceAddress(int sourceAddress)
Sets the packet source address.
Parameters:
sourceAddress - New source address for this packet.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getSourceAddress

public int getSourceAddress()
Retrieves the packet source address.
Returns:
Source address for this packet.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setDestinationAddress

public void setDestinationAddress(int destinationAddress)
Sets the packet destination address.
Parameters:
destinationAddress - New destination address for this packet.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDestinationAddress

public int getDestinationAddress()
Retrieves the packet destination address.
Returns:
Destination address for this packet.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setPacketType

public void setPacketType(int packetType)
Sets the packet type.
Parameters:
packetType - Type for this packet; one of these values: PACKET_TYPE_DATA, PACKET_TYPE_HPDATA, PACKET_TYPE_STATUS, or PACKET_TYPE_TEXT.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getPacketType

public int getPacketType()
Retrieves the packet type.
Returns:
One of these values: PACKET_TYPE_DATA, PACKET_TYPE_HPDATA, PACKET_TYPE_STATUS, or PACKET_TYPE_TEXT.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setPacketFlags

public void setPacketFlags(int packetFlags)
Sets specified packet flags.
Parameters:
packetFlags - Packet flags to set; one of these values: FLAG_MAILBOX, FLAG_POSACK, FLAG_SENDLIST, or FLAG_UNKNOWN.
Throws:
IllegalArgumentException - If the specified value is invalid.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getPacketFlags

public int getPacketFlags()
Retrieves the set of packet flags.
Returns:
One of these values: FLAG_MAILBOX, FLAG_POSACK, FLAG_SENDLIST, or FLAG_UNKNOWN.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setHPID

public void setHPID(int hpid)
Sets the higher protocol ID.
Parameters:
hpid - New HPID to set.
Since:
JDE 4.0.2
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getHPID

public int getHPID()
Retrieves the higher protocol ID.
Returns:
HPID for this packet.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getTrafficState

public int getTrafficState()
Retrieves the traffic state.
Returns:
One of these values: TS_CANNOT_BE_REACHED, TS_DESTINATION_BUSY, TS_ILLEGAL_MESSAGE, TS_MESSAGE_FROM_MAILBOX, TS_MESSAGE_IN_MAILBOX, TS_MESSAGE_OK, TS_NETWORK_CONGESTED, or TS_TECHNICAL_ERROR.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getMaxPacketSize

public static int getMaxPacketSize()
Retrieves the maximum packet size.
Returns:
Maximum allowable packet size.
Since:
JDE 4.0.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2004 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.