Package com.realtime.crossfire.jxclient.server.crossfire

Class AbstractCrossfireServerConnection

java.lang.Object

com.realtime.crossfire.jxclient.server.crossfire.AbstractCrossfireServerConnection

All Implemented Interfaces:

AskfaceQueue, CrossfireServerConnection, ServerConnection

Direct Known Subclasses:

DefaultCrossfireServerConnection

public abstract class AbstractCrossfireServerConnection
extends Object
implements CrossfireServerConnection

Abstract base class for CrossfireServerConnection implementing classes.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final @NotNull Charset	UTF8	The Charset used for parsing or encoding strings received from or sent to the Crossfire server.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCrossfireServerConnection(@NotNull Model model)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	addCrossfireAccountListener(@NotNull CrossfireAccountListener listener)	Adds a listener to be notified about account events.
void	addCrossfireComcListener(@NotNull CrossfireComcListener listener)	Adds a listener to be notified about received comc commands.
void	addCrossfireDrawextinfoListener(@NotNull CrossfireDrawextinfoListener listener)	Adds a new listener monitoring the drawextinfo S->C messages.
void	addCrossfireDrawinfoListener(@NotNull CrossfireDrawinfoListener listener)	Adds a new listener monitoring the drawinfo S->C messages.
void	addCrossfireFailureListener(@NotNull CrossfireFailureListener listener)	Adds a listener to be notified of failure messages.
void	addCrossfireMagicmapListener(@NotNull CrossfireMagicmapListener listener)	Adds a listener from the list of objects listening to magicmap messages.
void	addCrossfireMusicListener(@NotNull CrossfireMusicListener listener)	Adds a listener to be notified about received music commands.
void	addCrossfirePickupListener(@NotNull CrossfirePickupListener listener)	Adds a listener to be notified about received "pickup" messages.
void	addCrossfireQueryListener(@NotNull CrossfireQueryListener listener)	Adds a new listener monitoring the query S->C messages.
void	addCrossfireSoundListener(@NotNull CrossfireSoundListener listener)	Adds a listener to be notified about received sound commands.
void	addCrossfireTickListener(@NotNull CrossfireTickListener listener)	Adds a listener to be notified about tick changes.
void	addCrossfireUpdateItemListener(@NotNull CrossfireUpdateItemListener crossfireUpdateItemListener)	Adds a listener to be notified about item changes.
void	addPacketWatcherListener(@NotNull ReceivedPacketListener listener)	Adds a listener to be notified about received packets.
void	addSentPacketListener(@NotNull SentPacketListener listener)	Adds a listener to be notified about sent reply packets.
protected void	clearFailure()	Inform the various failure listeners that they can clean the last displayed failure.
void	drawextinfo(int color, int type, int subtype, @NotNull String message)	Pretends that a drawextinfo message has been received.
void	drawInfo(@NotNull String message, int color)	Pretends that a drawinfo message has been received.
void	drawInfoSetDebugMode(boolean printMessageTypes)	Enables or disables printing of message types.
protected void	fireAddAccount(@NotNull CharacterInformation characterInformation)
protected void	fireAddItemReceived(int location, int tag, int flags, int weight, int faceNum, String name, String namePl, int anim, int animSpeed, int nrof, int type)
protected void	fireCommandComcReceived(int packetNo, int time)
protected void	fireCommandQueryReceived(@NotNull String prompt, int queryType)
protected void	fireCommandSound2Received(int x, int y, int dir, int volume, int type, @NotNull String action, @NotNull String name)
protected void	fireCommandSoundReceived(int x, int y, int num, int type)
protected void	fireDelinvReceived(int tag)
protected void	fireDelitemReceived(int @NotNull [] tags)
protected void	fireEndAccountList(int count)
protected void	fireFaceReceived(int faceNum, int faceSetNum, int faceChecksum, @NotNull String faceName)
protected void	fireFailure(@NotNull String command, @NotNull String arguments)
protected void	fireMagicMap()
protected void	fireManageAccount()
protected void	fireMarkSent(int tag)	Notifies all listeners about a "mark" command that has been sent to the Crossfire server.
protected void	fireMusicReceived(@NotNull String music)
protected void	firePickupChanged(int pickupOptions)
protected void	firePlayerReceived(int tag, int weight, int faceNum, @NotNull String name)
protected void	fireReplySent()	Notifies all listeners about a "reply" command that has been sent to the Crossfire server.
protected void	fireSelectCharacter(@NotNull String accountName, @NotNull String characterName)
protected void	fireStartAccountList(@NotNull String accountName)
protected void	fireStartPlaying()
protected void	fireTick(int tickNo)
protected void	fireUpditemReceived(int flags, int tag, int valLocation, int valFlags, int valWeight, int valFaceNum, @NotNull String valName, @NotNull String valNamePl, int valAnim, int valAnimSpeed, int valNrof)
protected static @NotNull String	newString(@NotNull ByteBuffer byteBuffer, int start, int len)	Extracts a string from a ByteBuffer range.
protected void	notifyPacketWatcherListeners(@NotNull String command, @NotNull ClientSocketMonitorCommand args)	Notifies all ReceivedPacketListeners about a packet.
void	removeCrossfireAccountListener(@NotNull CrossfireAccountListener listener)	Removes a listener to be notified about account events.
void	removeCrossfireDrawextinfoListener(@NotNull CrossfireDrawextinfoListener listener)	Removes the given listener from the list of objects listening to the drawextinfo S->C messages.
void	removeCrossfireDrawinfoListener(@NotNull CrossfireDrawinfoListener listener)	Removes the given listener from the list of objects listening to the drawinfo S->C messages.
void	removeCrossfireFailureListener(@NotNull CrossfireFailureListener listener)	Removes a listener to be notified of failure messages.
void	removeCrossfireMagicmapListener(@NotNull CrossfireMagicmapListener listener)	Removes a listener from the list of objects listening to magicmap messages.
void	removeCrossfirePickupListener(@NotNull CrossfirePickupListener listener)	Removes a listener to be notified about received "pickup" messages.
void	removeCrossfireQueryListener(@NotNull CrossfireQueryListener listener)	Removes the given listener from the list of objects listening to the query S->C messages.
void	removeCrossfireUpdateItemListener(@NotNull CrossfireUpdateItemListener crossfireUpdateItemListener)	Removes a listener to be notified about item changes.
void	removePacketWatcherListener(@NotNull ReceivedPacketListener listener)	Removes a listener to be notified about received packets.
void	removeSentPacketListener(@NotNull SentPacketListener listener)	Removes a listener to be notified about sent reply packets.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.realtime.crossfire.jxclient.faces.AskfaceQueue

addFaceReceivedListener, sendAskface

Methods inherited from interface com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection

addCrossfireMapScrollListener, getAccountName, sendAccountCharacterCreate, sendAccountCreate, sendAccountLink, sendAccountLogin, sendAccountPassword, sendAccountPlay, sendAddme, sendApply, sendExamine, sendLock, sendLookat, sendMark, sendMove, sendNcom, sendRawString, sendReply, sendRequestinfo, sendSetup, sendToggleextendedtext, sendVersion, setCrossfireUpdateMapListener, setPreferredMapSize, setPreferredNumLookObjects, start, stop

Methods inherited from interface com.realtime.crossfire.jxclient.server.server.ServerConnection

addClientSocketListener, connect, disconnect, removeClientSocketListener

Field Details

UTF8

@NotNull
protected static final @NotNull Charset UTF8

The Charset used for parsing or encoding strings received from or sent to the Crossfire server.

Constructor Details

AbstractCrossfireServerConnection

protected AbstractCrossfireServerConnection(@NotNull
 @NotNull Model model)

Creates a new instance.

Parameters:

model - the model instance to update

Method Details

addCrossfireDrawinfoListener

public void addCrossfireDrawinfoListener(@NotNull
 @NotNull CrossfireDrawinfoListener listener)

Description copied from interface: CrossfireServerConnection

Adds a new listener monitoring the drawinfo S->C messages.

Specified by:

addCrossfireDrawinfoListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

removeCrossfireDrawinfoListener

public void removeCrossfireDrawinfoListener(@NotNull
 @NotNull CrossfireDrawinfoListener listener)

Description copied from interface: CrossfireServerConnection

Removes the given listener from the list of objects listening to the drawinfo S->C messages.

Specified by:

removeCrossfireDrawinfoListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

addCrossfireDrawextinfoListener

public void addCrossfireDrawextinfoListener(@NotNull
 @NotNull CrossfireDrawextinfoListener listener)

Description copied from interface: CrossfireServerConnection

Adds a new listener monitoring the drawextinfo S->C messages.

Specified by:

addCrossfireDrawextinfoListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

removeCrossfireDrawextinfoListener

public void removeCrossfireDrawextinfoListener(@NotNull
 @NotNull CrossfireDrawextinfoListener listener)

Description copied from interface: CrossfireServerConnection

Removes the given listener from the list of objects listening to the drawextinfo S->C messages.

Specified by:

removeCrossfireDrawextinfoListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

addCrossfireQueryListener

public void addCrossfireQueryListener(@NotNull
 @NotNull CrossfireQueryListener listener)

Description copied from interface: CrossfireServerConnection

Adds a new listener monitoring the query S->C messages.

Specified by:

addCrossfireQueryListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

removeCrossfireQueryListener

public void removeCrossfireQueryListener(@NotNull
 @NotNull CrossfireQueryListener listener)

Description copied from interface: CrossfireServerConnection

Removes the given listener from the list of objects listening to the query S->C messages.

Specified by:

removeCrossfireQueryListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

addCrossfireMagicmapListener

public void addCrossfireMagicmapListener(@NotNull
 @NotNull CrossfireMagicmapListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener from the list of objects listening to magicmap messages.

Specified by:

addCrossfireMagicmapListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

removeCrossfireMagicmapListener

public void removeCrossfireMagicmapListener(@NotNull
 @NotNull CrossfireMagicmapListener listener)

Description copied from interface: CrossfireServerConnection

Removes a listener from the list of objects listening to magicmap messages.

Specified by:

removeCrossfireMagicmapListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

addCrossfireUpdateItemListener

public void addCrossfireUpdateItemListener(@NotNull
 @NotNull CrossfireUpdateItemListener crossfireUpdateItemListener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about item changes.

Specified by:

addCrossfireUpdateItemListener in interface CrossfireServerConnection

Parameters:

crossfireUpdateItemListener - the listener to add

removeCrossfireUpdateItemListener

public void removeCrossfireUpdateItemListener(@NotNull
 @NotNull CrossfireUpdateItemListener crossfireUpdateItemListener)

Description copied from interface: CrossfireServerConnection

Removes a listener to be notified about item changes.

Specified by:

removeCrossfireUpdateItemListener in interface CrossfireServerConnection

Parameters:

crossfireUpdateItemListener - the listener to remove

addCrossfireTickListener

public void addCrossfireTickListener(@NotNull
 @NotNull CrossfireTickListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about tick changes.

Specified by:

addCrossfireTickListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addCrossfireSoundListener

public void addCrossfireSoundListener(@NotNull
 @NotNull CrossfireSoundListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about received sound commands.

Specified by:

addCrossfireSoundListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addCrossfireMusicListener

public void addCrossfireMusicListener(@NotNull
 @NotNull CrossfireMusicListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about received music commands.

Specified by:

addCrossfireMusicListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addCrossfireComcListener

public void addCrossfireComcListener(@NotNull
 @NotNull CrossfireComcListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about received comc commands.

Specified by:

addCrossfireComcListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addPacketWatcherListener

public void addPacketWatcherListener(@NotNull
 @NotNull ReceivedPacketListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about received packets.

Specified by:

addPacketWatcherListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addCrossfireAccountListener

public void addCrossfireAccountListener(@NotNull
 @NotNull CrossfireAccountListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about account events.

Specified by:

addCrossfireAccountListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

removeCrossfireAccountListener

public void removeCrossfireAccountListener(@NotNull
 @NotNull CrossfireAccountListener listener)

Description copied from interface: CrossfireServerConnection

Removes a listener to be notified about account events.

Specified by:

removeCrossfireAccountListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

removePacketWatcherListener

public void removePacketWatcherListener(@NotNull
 @NotNull ReceivedPacketListener listener)

Description copied from interface: CrossfireServerConnection

Removes a listener to be notified about received packets.

Specified by:

removePacketWatcherListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addSentPacketListener

public void addSentPacketListener(@NotNull
 @NotNull SentPacketListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about sent reply packets.

Specified by:

addSentPacketListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

removeSentPacketListener

public void removeSentPacketListener(@NotNull
 @NotNull SentPacketListener listener)

Description copied from interface: CrossfireServerConnection

Removes a listener to be notified about sent reply packets.

Specified by:

removeSentPacketListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

addCrossfirePickupListener

public void addCrossfirePickupListener(@NotNull
 @NotNull CrossfirePickupListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified about received "pickup" messages.

Specified by:

addCrossfirePickupListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

removeCrossfirePickupListener

public void removeCrossfirePickupListener(@NotNull
 @NotNull CrossfirePickupListener listener)

Description copied from interface: CrossfireServerConnection

Removes a listener to be notified about received "pickup" messages.

Specified by:

removeCrossfirePickupListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

addCrossfireFailureListener

public void addCrossfireFailureListener(@NotNull
 @NotNull CrossfireFailureListener listener)

Description copied from interface: CrossfireServerConnection

Adds a listener to be notified of failure messages.

Specified by:

addCrossfireFailureListener in interface CrossfireServerConnection

Parameters:

listener - the listener to add

removeCrossfireFailureListener

public void removeCrossfireFailureListener(@NotNull
 @NotNull CrossfireFailureListener listener)

Description copied from interface: CrossfireServerConnection

Removes a listener to be notified of failure messages.

Specified by:

removeCrossfireFailureListener in interface CrossfireServerConnection

Parameters:

listener - the listener to remove

fireManageAccount

protected void fireManageAccount()

fireStartAccountList

protected void fireStartAccountList(@NotNull
 @NotNull String accountName)

fireAddAccount

protected void fireAddAccount(@NotNull
 @NotNull CharacterInformation characterInformation)

fireEndAccountList

protected void fireEndAccountList(int count)

fireStartPlaying

protected void fireStartPlaying()

fireCommandComcReceived

protected void fireCommandComcReceived(int packetNo,
 int time)

fireDelinvReceived

protected void fireDelinvReceived(int tag)

fireDelitemReceived

protected void fireDelitemReceived(int @NotNull [] tags)

fireFaceReceived

protected void fireFaceReceived(int faceNum,
 int faceSetNum,
 int faceChecksum,
 @NotNull
 @NotNull String faceName)

fireFailure

protected void fireFailure(@NotNull
 @NotNull String command,
 @NotNull
 @NotNull String arguments)

clearFailure

protected void clearFailure()

Inform the various failure listeners that they can clean the last displayed failure.

fireAddItemReceived

protected void fireAddItemReceived(int location,
 int tag,
 int flags,
 int weight,
 int faceNum,
 String name,
 String namePl,
 int anim,
 int animSpeed,
 int nrof,
 int type)

fireMagicMap

protected void fireMagicMap()

fireMusicReceived

protected void fireMusicReceived(@NotNull
 @NotNull String music)

firePickupChanged

protected void firePickupChanged(int pickupOptions)

firePlayerReceived

protected void firePlayerReceived(int tag,
 int weight,
 int faceNum,
 @NotNull
 @NotNull String name)

fireCommandQueryReceived

protected void fireCommandQueryReceived(@NotNull
 @NotNull String prompt,
 int queryType)

fireCommandSoundReceived

protected void fireCommandSoundReceived(int x,
 int y,
 int num,
 int type)

fireCommandSound2Received

protected void fireCommandSound2Received(int x,
 int y,
 int dir,
 int volume,
 int type,
 @NotNull
 @NotNull String action,
 @NotNull
 @NotNull String name)

fireTick

protected void fireTick(int tickNo)

fireUpditemReceived

protected void fireUpditemReceived(int flags,
 int tag,
 int valLocation,
 int valFlags,
 int valWeight,
 int valFaceNum,
 @NotNull
 @NotNull String valName,
 @NotNull
 @NotNull String valNamePl,
 int valAnim,
 int valAnimSpeed,
 int valNrof)

drawInfo

public void drawInfo(@NotNull
 @NotNull String message,
 int color)

Description copied from interface: CrossfireServerConnection

Pretends that a drawinfo message has been received.

Specified by:

drawInfo in interface CrossfireServerConnection

Parameters:

message - the message

color - the color

drawextinfo

public void drawextinfo(int color,
 int type,
 int subtype,
 @NotNull
 @NotNull String message)

Description copied from interface: CrossfireServerConnection

Pretends that a drawextinfo message has been received.

Specified by:

drawextinfo in interface CrossfireServerConnection

Parameters:

color - the color

type - the message type

subtype - the message subtype

message - the message

drawInfoSetDebugMode

public void drawInfoSetDebugMode(boolean printMessageTypes)

Description copied from interface: CrossfireServerConnection

Enables or disables printing of message types.

Specified by:

drawInfoSetDebugMode in interface CrossfireServerConnection

Parameters:

printMessageTypes - whether to enable or disable message types

fireMarkSent

protected void fireMarkSent(int tag)

Notifies all listeners about a "mark" command that has been sent to the Crossfire server.

Parameters:

tag - the tag of the marked item

fireReplySent

protected void fireReplySent()

Notifies all listeners about a "reply" command that has been sent to the Crossfire server.

notifyPacketWatcherListeners

protected void notifyPacketWatcherListeners(@NotNull
 @NotNull String command,
 @NotNull
 @NotNull ClientSocketMonitorCommand args)

Notifies all ReceivedPacketListeners about a packet.

Parameters:

command - the command string

args - the command arguments

newString

@NotNull
protected static @NotNull String newString(@NotNull
 @NotNull ByteBuffer byteBuffer,
 int start,
 int len)

Extracts a string from a ByteBuffer range.

Parameters:

byteBuffer - the byte buffer

start - the start index of the string

len - the length of the string

Returns:

the string

fireSelectCharacter

protected void fireSelectCharacter(@NotNull
 @NotNull String accountName,
 @NotNull
 @NotNull String characterName)