net.kano.joscar.snaccmd.conn
Class PauseCmd

java.lang.Object
  extended bySnacCommand
      extended byConnCommand
          extended byPauseCmd

public class PauseCmd
extends ConnCommand

A SNAC command sent to tell the client to stop sending packets and to send a PauseAck. This is the first step of the migration process; the next command sent by the server is normally one of MigrationNotice and ResumeCmd.

See Also:
PauseAck
Source of this SNAC:
AIM server
SNAC command type:
Family 0x01, command 0x0b

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
  PauseCmd()
          Creates a new outgoing pause command.
protected PauseCmd(SnacPacket packet)
          Generates a new pause command from the given incoming SNAC packet.
 
Method Summary
 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

PauseCmd

protected PauseCmd(SnacPacket packet)
Generates a new pause command from the given incoming SNAC packet.

Parameters:
packet - an incoming pause command packet

PauseCmd

public PauseCmd()
Creates a new outgoing pause command.

Method Detail

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()