kreverse.krlib
Class KRClient

java.lang.Object
  extended by kreverse.krlib.KRClient
All Implemented Interfaces:
java.lang.Runnable

public class KRClient
extends java.lang.Object
implements java.lang.Runnable

Hauptklasse der Library, die eine Verbindung zum Server herstellt. Kann zum Abfangen und Verarbeiten von Paketen überschrieben werden.

Since:
1.0
Author:
Flav

Constructor Summary
KRClient()
           
 
Method Summary
 void connect(RemoteEndpoint endpoint)
          Stellt eine Verbindung zu dem im Parameter RemoteEndpoint angegebenen Knuddels-Chatserver her.
 void connect(RemoteEndpoint endpoint, java.lang.String proxyHost, int proxyPort)
          Stellt eine Verbindung zu dem im Parameter RemoteEndpoint angegebenen Knuddels-Chatserver über den angegebenen Socks-Proxy her.
 void connect(java.lang.String host, int port)
          Stellt eine Verbindung zu dem Knuddels-Server her, der mit Host und Port angegeben wird.
 void connect(java.lang.String host, int port, java.lang.String proxyHost, int proxyPort)
          Stellt eine Verbindung zum angegebenen Knuddels-Server mit dem angegebenen Socks-Proxy her.
 void disconnect()
          Trennt die Verbindung zum Chat.
 boolean isConnected()
          Gibt true zurück wenn eine Verbindung zum Chatserver besteht, false wenn nicht.
 void login(java.lang.String nickname, java.lang.String password, java.lang.String channel)
          Loggt einen Nick in das Knuddels-Chatsystem ein.
 void onDisconnect()
          Wird aufgerufen, wenn die Verbindung vom Chatserver getrennt wurde.
 void onReceive(java.lang.String packet)
          In dieser Methode kommen alle eingehenden Pakete vom Knuddels-Server an.
 void run()
           
 void send(java.lang.String packet)
          Sendet ein Paket zum Chatserver.
 void sendMessage(java.lang.String message, java.lang.String channel)
          Sendet eine öffentliche Nachricht in den angegebenen Channel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KRClient

public KRClient()
Method Detail

isConnected

public final boolean isConnected()
Gibt true zurück wenn eine Verbindung zum Chatserver besteht, false wenn nicht.

Returns:
true wenn eine Verbindung zum Chatserver besteht, false wenn nicht.
Since:
2.1

connect

public final void connect(java.lang.String host,
                          int port)
                   throws java.io.IOException
Stellt eine Verbindung zu dem Knuddels-Server her, der mit Host und Port angegeben wird.

Parameters:
host - der Chathost, zu dem eine Verbindung aufgebaut werden soll.
port - der zum Chathost entsprechende Port von Knuddels.
Throws:
java.io.IOException
Since:
1.0

connect

public final void connect(RemoteEndpoint endpoint)
                   throws java.io.IOException
Stellt eine Verbindung zu dem im Parameter RemoteEndpoint angegebenen Knuddels-Chatserver her.

Parameters:
endpoint - das Knuddels-Chatsystem, mit dem eine Verbindung hergestellt werden soll (z. B. RemoteEndpoint.DE für Knuddels.de).
Throws:
java.io.IOException
Since:
2.0

connect

public final void connect(java.lang.String host,
                          int port,
                          java.lang.String proxyHost,
                          int proxyPort)
                   throws java.io.IOException
Stellt eine Verbindung zum angegebenen Knuddels-Server mit dem angegebenen Socks-Proxy her.

Parameters:
host - der Chathost, zu dem eine Verbindung aufgebaut werden soll.
port - der zum Chathost entsprechende Port von Knuddels.
proxyHost - Host oder IP-Adresse des Proxyservers.
proxyPort - dazugehöriger Port des Proxys.
Throws:
java.io.IOException
Since:
1.0

connect

public final void connect(RemoteEndpoint endpoint,
                          java.lang.String proxyHost,
                          int proxyPort)
                   throws java.io.IOException
Stellt eine Verbindung zu dem im Parameter RemoteEndpoint angegebenen Knuddels-Chatserver über den angegebenen Socks-Proxy her.

Parameters:
endpoint - das Knuddels-Chatsystem, mit dem eine Verbindung hergestellt werden soll (z. B. RemoteEndpoint.DE für Knuddels.de).
proxyHost - Host oder IP-Adresse des Proxyservers.
proxyPort - dazugehöriger Port des Proxys.
Throws:
java.io.IOException
Since:
2.0

login

public final void login(java.lang.String nickname,
                        java.lang.String password,
                        java.lang.String channel)
Loggt einen Nick in das Knuddels-Chatsystem ein.

Parameters:
nickname - der einzuloggende Knuddels-Nickname.
password - das zum Nickname dazugehörige Passwort.
channel - der Knuddels-Channel, in den der Nick eingeloggt werden soll.
Since:
1.0

sendMessage

public final void sendMessage(java.lang.String message,
                              java.lang.String channel)
Sendet eine öffentliche Nachricht in den angegebenen Channel

Parameters:
message - die Nachricht, welche gesendet werden soll.
channel - der Channel, in dem die Nachricht gesendet wird.
Since:
1.0

onReceive

public void onReceive(java.lang.String packet)
In dieser Methode kommen alle eingehenden Pakete vom Knuddels-Server an. Durch das Überschreiben dieser Methode kann man alle eingehenden Pakete mitschneiden und ggf. weiterverarbeiten.

Parameters:
packet - das empfangene Paket.
Since:
1.0

onDisconnect

public void onDisconnect()
Wird aufgerufen, wenn die Verbindung vom Chatserver getrennt wurde.

Since:
1.0

run

public final void run()
Specified by:
run in interface java.lang.Runnable

send

public final void send(java.lang.String packet)
Sendet ein Paket zum Chatserver.

Parameters:
packet - das Paket, welches zum Chatserver gesendet werden soll.
Since:
1.0

disconnect

public final void disconnect()
Trennt die Verbindung zum Chat.

Since:
1.0