net.kano.joscar.rvproto.rvproxy
Class RvProxyInitRecvCmd

java.lang.Object
  extended byRvProxyCmd
      extended byRvProxyInitRecvCmd

public class RvProxyInitRecvCmd
extends RvProxyCmd

An AOL Proxy Server command used to initialize a connection when "receiving" an AOL-Proxy-based connection. That is, a command used to initialize an AOL proxy server connection after one has received an invitation to connect to an AOL Proxy Server for a direct connection, file transfer, or other direct TCP connection based rendezvous type.

Source of this RV Proxy command:
AIM client

Constructor Summary
protected RvProxyInitRecvCmd(RvProxyPacket header)
          Creates a new RV proxy connection initialization command from the given incoming RV proxy packet.
  RvProxyInitRecvCmd(java.lang.String sn, long icbmMessageId, int port)
          Creates a new outgoing RV proxy receiving-end initialization command with the given properties.
 
Method Summary
 long getIcbmMessageId()
          Returns the ICBM message ID "cookie" sent in this command.
 int getPort()
          Returns the "port" value sent in this command.
 java.lang.String getScreenname()
          Returns the screenname value sent in this command.
 java.lang.String toString()
           
 void writeCommandData(java.io.OutputStream out)
          Writes this command's raw "command-specific data" to the given stream.
 
Methods inherited from class RvProxyCmd
getCommandType, getFlags, getPacketVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RvProxyInitRecvCmd

protected RvProxyInitRecvCmd(RvProxyPacket header)
Creates a new RV proxy connection initialization command from the given incoming RV proxy packet.

Parameters:
header - an incoming connection initialization RV proxy packet

RvProxyInitRecvCmd

public RvProxyInitRecvCmd(java.lang.String sn,
                          long icbmMessageId,
                          int port)
Creates a new outgoing RV proxy receiving-end initialization command with the given properties.

Parameters:
sn - the screenname of the connecting client (that is, if being used by a client, "your" screenname)
icbmMessageId - an ICBM message ID "cookie," normally the ICBM message ID of the RV ICBM command which invited the user to make the associated proxy connection
port - the "port" value sent in the RV ICBM command which invited user to make the associated proxy connection
Method Detail

getScreenname

public final java.lang.String getScreenname()
Returns the screenname value sent in this command. Note that this is normally the screenname of the connecting user.

Returns:
the screenname value sent in this command

getIcbmMessageId

public final long getIcbmMessageId()
Returns the ICBM message ID "cookie" sent in this command. This value is a "cookie" that appears to be used to match up two clients who desire to make a connection over the AOL Proxy Server.

Returns:
the ICBM message ID "cookie" value sent in this command

getPort

public final int getPort()
Returns the "port" value sent in this command. As of this writing, the significance of this value is unknown; it is known, however, that this is the same value as the port value sent to the initiating client in a RvProxyAckCmd.

Returns:
the "port" value sent in this command

writeCommandData

public void writeCommandData(java.io.OutputStream out)
                      throws java.io.IOException
Description copied from class: RvProxyCmd
Writes this command's raw "command-specific data" to the given stream.

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

toString

public java.lang.String toString()