|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectMissedMsgInfo
A data structure used to transmit information about messages that could not be sent for some reason.
Field Summary | |
static int |
REASON_SENDER_WARNING_LEVEL
A reason code indicating that the sender has a warning level higher than the "sender" warning level set in your ICBM parameters. |
static int |
REASON_TOO_FAST
A reason code indicating that the message was sent too fast according to your ICBM parameters. |
static int |
REASON_TOO_LARGE
A reason code indicating that the message was too large according to your ICBM parameters. |
static int |
REASON_YOUR_WARNING_LEVEL
A reason code indicating that your warning level is higher than the sender's "receiver warning level" in his ICBM parameters. |
Constructor Summary | |
MissedMsgInfo(int channel,
FullUserInfo userInfo,
int number,
int reason)
Creates a new missed message block with the given properties. |
Method Summary | |
int |
getChannel()
Returns the ICBM channel on which the messages were missed. |
int |
getNumberMissed()
Returns the number of messages missed. |
int |
getReasonCode()
Returns a code indicating why the messages were missed. |
int |
getTotalSize()
Returns the total size of this structure, as read from a block of binary data. |
FullUserInfo |
getUserInfo()
Returns a user information block for the user whose messages were missed. |
protected static MissedMsgInfo |
readMissedMsgInfo(ByteBlock block)
Returns a missed message information object read from the given block of bytes. |
java.lang.String |
toString()
|
void |
write(java.io.OutputStream out)
Writes a representation of this object to the given stream. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int REASON_TOO_LARGE
public static final int REASON_TOO_FAST
public static final int REASON_SENDER_WARNING_LEVEL
public static final int REASON_YOUR_WARNING_LEVEL
Constructor Detail |
public MissedMsgInfo(int channel, FullUserInfo userInfo, int number, int reason)
channel
- the ICBM channel on which the message was misseduserInfo
- an object describing the user whose messages were missednumber
- the number of messages missedreason
- a code indicating the reason the messages were missed,
like REASON_TOO_LARGE
Method Detail |
protected static MissedMsgInfo readMissedMsgInfo(ByteBlock block)
block
- the block of bytes contaoning missed message information
public final int getChannel()
AbstractIcbm.CHANNEL_IM
.
public final FullUserInfo getUserInfo()
public final int getNumberMissed()
public final int getReasonCode()
REASON_TOO_FAST
, REASON_TOO_LARGE
, REASON_SENDER_WARNING_LEVEL
, and REASON_YOUR_WARNING_LEVEL
.
public final int getTotalSize()
-1
if this object was not read in from a block
of data.
public void write(java.io.OutputStream out) throws java.io.IOException
LiveWritable
write
in interface LiveWritable
out
- the stream to which to write
java.io.IOException
- if an I/O error occurspublic java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |