com.mooapi.common.command.server
Class ConnectionDetails

java.lang.Object
  extended by com.mooapi.common.command.server.AbstractServerCommand
      extended by com.mooapi.common.command.server.ConnectionDetails
All Implemented Interfaces:
Command

public class ConnectionDetails
extends AbstractServerCommand

MooAPI connection info output command. The command that is sent to a connection that is new to a channel to notify it of an existing connection in the channel.

Author:
Steve Taylor

Constructor Summary
ConnectionDetails(int connectionId, int channelId, int masterConnectionId, java.lang.String connectionName, java.lang.String connectionIpAddress)
          Initialize.
 
Method Summary
static ConnectionDetails decode(org.apache.mina.common.ByteBuffer buffer)
           
 org.apache.mina.common.ByteBuffer encode()
          Encode this command as a byte stream.
 boolean equals(java.lang.Object obj)
           
 int getChannelId()
          Get the channel ID.
 int getConnectionId()
          Get the connection ID.
 java.lang.String getConnectionIpAddress()
          Get the connection's IP address.
 java.lang.String getConnectionName()
          Get the connection name.
 int getMasterConnectionId()
          Get the channel's master connection ID.
 int hashCode()
           
 java.lang.String toString()
          Generate a string representation of this message.
 
Methods inherited from class com.mooapi.common.command.server.AbstractServerCommand
getType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConnectionDetails

public ConnectionDetails(int connectionId,
                         int channelId,
                         int masterConnectionId,
                         java.lang.String connectionName,
                         java.lang.String connectionIpAddress)
Initialize.

Parameters:
connectionId - A connection ID that is already in the channel.
channelId - The channel ID.
masterConnectionId - The channel's master connection ID.
connectionName - A connection name that is already in the channel.
connectionIpAddress - The IP address of a connection that is already in the channel.
Method Detail

decode

public static ConnectionDetails decode(org.apache.mina.common.ByteBuffer buffer)
Parameters:
buffer -
Returns:

encode

public org.apache.mina.common.ByteBuffer encode()
Encode this command as a byte stream.

Specified by:
encode in class AbstractServerCommand
Returns:
A buffer containing the encoded command.

getConnectionId

public int getConnectionId()
Get the connection ID.

Returns:
The connection ID.

getChannelId

public int getChannelId()
Get the channel ID.

Returns:
The channel ID.

getMasterConnectionId

public int getMasterConnectionId()
Get the channel's master connection ID.

Returns:
The master connection ID.

getConnectionName

public java.lang.String getConnectionName()
Get the connection name.

Returns:
The connection name.

getConnectionIpAddress

public java.lang.String getConnectionIpAddress()
Get the connection's IP address.

Returns:
The connection's IP address.

toString

public java.lang.String toString()
Generate a string representation of this message.

Specified by:
toString in class AbstractServerCommand
Returns:
A string representation of this message.

equals

public boolean equals(java.lang.Object obj)
Specified by:
equals in class AbstractServerCommand
Parameters:
obj -
Returns:

hashCode

public int hashCode()
Specified by:
hashCode in class AbstractServerCommand
Returns:


Copyright © 2009. All Rights Reserved.