net.kano.joscar.snaccmd.icbm
Class RecvRvIcbm

java.lang.Object
  extended bySnacCommand
      extended byAbstractIcbm
          extended byAbstractRvIcbm
              extended byRecvRvIcbm

public class RecvRvIcbm
extends AbstractRvIcbm

A SNAC command containing rendezvous information.

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

Field Summary
 
Fields inherited from class AbstractRvIcbm
RVSTATUS_ACCEPT, RVSTATUS_DENY, RVSTATUS_REQUEST
 
Fields inherited from class AbstractIcbm
CHANNEL_CHAT, CHANNEL_IM, CHANNEL_RV
 
Fields inherited from class SnacCommand
SNACFLAG_DEFAULT
 
Constructor Summary
  RecvRvIcbm(long icbmMessageId, int status, long rvSessionId, CapabilityBlock cap, LiveWritable rvDataWriter, FullUserInfo sender)
          Creates a new outgoing client-bound ICBM with the given properties.
protected RecvRvIcbm(SnacPacket packet)
          Generates an incoming rendezvous ICBM command from the given incoming SNAC packet.
 
Method Summary
 FullUserInfo getSender()
          Returns a user information block for the user who sent this rendezvous.
 java.lang.String toString()
           
protected  void writeChannelData(java.io.OutputStream out)
          Writes the channel-specific data for this ICBM command to the given output stream.
 
Methods inherited from class AbstractRvIcbm
getCapability, getRvData, getRvSessionId, getRvStatus
 
Methods inherited from class AbstractIcbm
getChannel, getChannelData, getIcbmChannel, getIcbmMessageId, writeData
 
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

RecvRvIcbm

protected RecvRvIcbm(SnacPacket packet)
Generates an incoming rendezvous ICBM command from the given incoming SNAC packet.

Parameters:
packet - an incoming rendezvous ICBM packet

RecvRvIcbm

public RecvRvIcbm(long icbmMessageId,
                  int status,
                  long rvSessionId,
                  CapabilityBlock cap,
                  LiveWritable rvDataWriter,
                  FullUserInfo sender)
Creates a new outgoing client-bound ICBM with the given properties.

Parameters:
icbmMessageId - an ICBM message ID to associate with this rendezvous command
status - a status code, like AbstractRvIcbm.RVSTATUS_REQUEST
rvSessionId - a rendezvous session ID on which this rendezvous exists
cap - this rendezvous's associated capability block
rvDataWriter - an object used to write the rendezvous-specific data
sender - an object describing the user who sent this rendezvous
Method Detail

getSender

public final FullUserInfo getSender()
Returns a user information block for the user who sent this rendezvous.

Returns:
user information for the sender of this rendezvous

writeChannelData

protected final void writeChannelData(java.io.OutputStream out)
                               throws java.io.IOException
Description copied from class: AbstractIcbm
Writes the channel-specific data for this ICBM command to the given output stream.

Specified by:
writeChannelData in class AbstractIcbm
Parameters:
out - the stream to write to
Throws:
java.io.IOException - if an I/O error occurs

toString

public java.lang.String toString()
Overrides:
toString in class AbstractRvIcbm