|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.eurotech.framework.net.admin.modem.sierra.Hip
public class Hip
Describes HIP (Host Interface Protocol) object.
The Host Interface Protocol is a multiplexing layer designed to allow several types of message streams to share the same physical link layer. CnS is one of the supported streams. HIP is used to carry control and status data between the modem and the host to provide management of the modem device. This management consists of:
� Non-volatile configuration of the device
� Run-time configuration of the device
� Status reporting and monitoring of the device
This protocol does not include checksums. It relies on a high-reliability physical interface between the host and the modem to reduce the processing burden on the microprocessor.
HIP format:
Byte offset | Content |
---|---|
0 | Framing character (0x7E) |
1-2 | Length of ooptional payload |
3 | Message ID |
4 | Parameter |
5-n | Optional payload |
n+1 | Framing character (0x7E) |
The minimum length of a HIP packet is six bytes, for a packet without the optional payload. Note that such a packet would have the first field set to 0x0000�no payload.
Copyright (c) 2009 Eurotech Inc. All rights reserved.
Field Summary | |
---|---|
static byte |
FRAME_BYTE
Frame byte delimiter. |
static int |
MIN_MSG_SIZE
Minimum message size. |
static byte |
MSGID_CNS_HOST2MODEM
Indicates host to modem message direction. |
static byte |
MSGID_CNS_MODEM2HOST
Indicates modem to host message direction. |
Constructor Summary | |
---|---|
Hip(byte[] payload)
HIP request constructor |
|
Hip(List<Byte> alMsg)
HIP reply constructor |
Method Summary | |
---|---|
byte[] |
getHIPmessage()
Reports HIP message |
byte |
getMessageID()
Reports message ID |
byte[] |
getPayload()
Reports HIP payload |
boolean |
isError()
Reports if there is an error in processing HIP reply |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final byte MSGID_CNS_HOST2MODEM
public static final byte MSGID_CNS_MODEM2HOST
public static final int MIN_MSG_SIZE
public static final byte FRAME_BYTE
Constructor Detail |
---|
public Hip(byte[] payload)
payload
- - HIP payloadpublic Hip(List<Byte> alMsg)
alMsg
- - HIP replyMethod Detail |
---|
public byte[] getHIPmessage()
public byte[] getPayload()
public byte getMessageID()
public boolean isError()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |