net.kano.joscar.snaccmd.conn
Class RateInfoCmd

java.lang.Object
  extended bySnacCommand
      extended byConnCommand
          extended byRateInfoCmd

public class RateInfoCmd
extends ConnCommand

A SNAC command sent to inform the client of a set of rate-limiting information. It is currently mostly unknown how all this works; see RateClassInfo for the best explanation so far. Normally sent in response to a RateInfoRequest.

See Also:
RateInfoRequest, RateAck
Source of this SNAC:
AIM server
SNAC command type:
Family 0x01, command 0x07

Field Summary
 
Fields inherited from class ConnCommand
CMD_CLIENT_READY, CMD_CLIENT_VERS, CMD_ENCINFOACK, CMD_EXTRA_ACK, CMD_MIGRATE_PLS, CMD_MY_INFO_REQ, CMD_NOOP, CMD_PAUSE, CMD_PAUSE_ACK, CMD_RATE_ACK, CMD_RATE_CHG, CMD_RATE_INFO, CMD_RATE_REQ, CMD_RESUME, CMD_SERV_VERS, CMD_SERVER_READY, CMD_SERVICE_REDIR, CMD_SERVICE_REQ, CMD_SET_IDLE, CMD_SETENCINFO, CMD_SETEXTRAINFO, CMD_UPDATE, CMD_WARNED, CMD_YOUR_INFO, FAMILY_CONN, FAMILY_INFO
 
Fields inherited from class SnacCommand
SNACFLAG_DEFAULT
 
Constructor Summary
  RateInfoCmd(RateClassInfo[] infos)
          Creates a new outgoing rate information command with the given rate class information blocks.
protected RateInfoCmd(SnacPacket packet)
          Generates a rate information command from the given incoming SNAC command.
 
Method Summary
 RateClassInfo[] getRateClassInfos()
          Returns the rate class information blocks sent in this command.
 java.lang.String toString()
           
 void writeData(java.io.OutputStream out)
          Writes this command's SNAC data block to the given stream.
 
Methods inherited from class SnacCommand
getCommand, getFamily, getFlag1, getFlag2
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RateInfoCmd

protected RateInfoCmd(SnacPacket packet)
Generates a rate information command from the given incoming SNAC command.

Parameters:
packet - an incoming rate information packet

RateInfoCmd

public RateInfoCmd(RateClassInfo[] infos)
Creates a new outgoing rate information command with the given rate class information blocks.

Parameters:
infos - a set of rate information blocks to send in this command
Method Detail

getRateClassInfos

public RateClassInfo[] getRateClassInfos()
Returns the rate class information blocks sent in this command.

Returns:
this command's enclosed rate class information blocks

writeData

public void writeData(java.io.OutputStream out)
               throws java.io.IOException
Description copied from class: SnacCommand
Writes this command's SNAC data block to the given stream. The SNAC data block is the data after the first ten bytes of a SNAC packet.

Specified by:
writeData in class SnacCommand
Parameters:
out - the stream to which to write the SNAC data
Throws:
java.io.IOException - if an I/O error occurs

toString

public java.lang.String toString()