com.realtime.crossfire.jxclient.scripts.PacketWatcher Class Reference

Implements the "watch" function for client-sided scripts. More...

Collaboration diagram for com.realtime.crossfire.jxclient.scripts.PacketWatcher:

Public Member Functions
void	addCommand (@NotNull final String command)
	Adds a command to watch for. More...
void	destroy ()
	Releases allocated resources. More...
	PacketWatcher (@NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final ScriptProcess scriptProcess)
	Creates a new instance. More...
void	removeCommand (@NotNull final String command)
	Removes a command to watch for. More...

Private Member Functions
boolean	matchesCommand (@NotNull final CharSequence command)
	Returns whether a command matches the currently watched commands. More...
void	rebuildPattern ()
	Rebuilds pattern from commands. More...

Private Attributes
final Collection< String >	commands = new HashSet<>()
	The commands to watch for. More...
final CrossfireServerConnection	crossfireServerConnection
	The CrossfireServerConnection to watch. More...
Pattern	pattern
	A Pattern matching all commands. More...
final ReceivedPacketListener	receivedPacketListener
	The ReceivedPacketListener attached to crossfireServerConnection. More...
final ScriptProcess	scriptProcess
	The ScriptProcess for sending commands. More...

Detailed Description

Implements the "watch" function for client-sided scripts.

Author

Andreas Kirschbaum

Definition at line 38 of file PacketWatcher.java.

Constructor & Destructor Documentation

PacketWatcher()

com.realtime.crossfire.jxclient.scripts.PacketWatcher.PacketWatcher	(	@NotNull final CrossfireServerConnection	crossfireServerConnection,
		@NotNull final ScriptProcess	scriptProcess
	)

Creates a new instance.

Parameters

crossfireServerConnection	the server connection to watch
scriptProcess	the script process for sending commands

Definition at line 92 of file PacketWatcher.java.

References com.realtime.crossfire.jxclient.scripts.PacketWatcher.crossfireServerConnection, com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern(), and com.realtime.crossfire.jxclient.scripts.PacketWatcher.scriptProcess.

Here is the call graph for this function:

Member Function Documentation

addCommand()

void com.realtime.crossfire.jxclient.scripts.PacketWatcher.addCommand

(

@NotNull final String

command

)

Adds a command to watch for.

Parameters

command

the command

Definition at line 137 of file PacketWatcher.java.

References com.realtime.crossfire.jxclient.scripts.PacketWatcher.commands, and com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern().

Referenced by com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.runScriptCommand(), and com.realtime.crossfire.jxclient.scripts.PacketWatcherTest.test1().

Here is the call graph for this function:

Here is the caller graph for this function:

destroy()

void com.realtime.crossfire.jxclient.scripts.PacketWatcher.destroy

(

)

Releases allocated resources.

Must be called before this instance is freed.

Definition at line 102 of file PacketWatcher.java.

References com.realtime.crossfire.jxclient.scripts.PacketWatcher.crossfireServerConnection, com.realtime.crossfire.jxclient.scripts.PacketWatcher.pattern, com.realtime.crossfire.jxclient.scripts.PacketWatcher.receivedPacketListener, and com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.removePacketWatcherListener().

Referenced by com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.run().

Here is the call graph for this function:

Here is the caller graph for this function:

matchesCommand()

boolean com.realtime.crossfire.jxclient.scripts.PacketWatcher.matchesCommand ( @NotNull final CharSequence  command )

private

Returns whether a command matches the currently watched commands.

Parameters

command

the command

Returns

whether the command matches

Definition at line 158 of file PacketWatcher.java.

References com.realtime.crossfire.jxclient.scripts.PacketWatcher.pattern.

rebuildPattern()

void com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern ( )

private

Rebuilds pattern from commands.

Definition at line 112 of file PacketWatcher.java.

References com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.addPacketWatcherListener(), com.realtime.crossfire.jxclient.scripts.PacketWatcher.commands, com.realtime.crossfire.jxclient.scripts.PacketWatcher.crossfireServerConnection, com.realtime.crossfire.jxclient.scripts.PacketWatcher.pattern, com.realtime.crossfire.jxclient.scripts.PacketWatcher.receivedPacketListener, and com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection.removePacketWatcherListener().

Referenced by com.realtime.crossfire.jxclient.scripts.PacketWatcher.addCommand(), com.realtime.crossfire.jxclient.scripts.PacketWatcher.PacketWatcher(), and com.realtime.crossfire.jxclient.scripts.PacketWatcher.removeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

removeCommand()

void com.realtime.crossfire.jxclient.scripts.PacketWatcher.removeCommand

(

@NotNull final String

command

)

Removes a command to watch for.

Parameters

command

the command

Definition at line 147 of file PacketWatcher.java.

References com.realtime.crossfire.jxclient.scripts.PacketWatcher.commands, and com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern().

Referenced by com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.runScriptCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

commands

final Collection<String> com.realtime.crossfire.jxclient.scripts.PacketWatcher.commands = new HashSet<>()

private

The commands to watch for.

Definition at line 44 of file PacketWatcher.java.

Referenced by com.realtime.crossfire.jxclient.scripts.PacketWatcher.addCommand(), com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern(), and com.realtime.crossfire.jxclient.scripts.PacketWatcher.removeCommand().

crossfireServerConnection

final CrossfireServerConnection com.realtime.crossfire.jxclient.scripts.PacketWatcher.crossfireServerConnection

private

The CrossfireServerConnection to watch.

Definition at line 50 of file PacketWatcher.java.

Referenced by com.realtime.crossfire.jxclient.scripts.PacketWatcher.destroy(), com.realtime.crossfire.jxclient.scripts.PacketWatcher.PacketWatcher(), and com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern().

pattern

Pattern com.realtime.crossfire.jxclient.scripts.PacketWatcher.pattern

private

A Pattern matching all commands.

Set to

null 

when not watching for commands.

Definition at line 63 of file PacketWatcher.java.

Referenced by com.realtime.crossfire.jxclient.scripts.PacketWatcher.destroy(), com.realtime.crossfire.jxclient.scripts.PacketWatcher.matchesCommand(), and com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern().

receivedPacketListener

final ReceivedPacketListener com.realtime.crossfire.jxclient.scripts.PacketWatcher.receivedPacketListener

private

Initial value:

= new ReceivedPacketListener() {
 
        @Override
        public void process(@NotNull final String command, @NotNull final ClientSocketMonitorCommand args) {
            if (matchesCommand(command)) {
                final String args2 = args.getMonitorCommand();
                if (args2.isEmpty()) {
                    scriptProcess.commandSent("watch "+command);
                } else {
                    scriptProcess.commandSent("watch "+command+" "+args2);
                }
            }
        }
 
    }

The ReceivedPacketListener attached to crossfireServerConnection.

It is attached if and only if pattern is non-

null 

.

Definition at line 71 of file PacketWatcher.java.

Referenced by com.realtime.crossfire.jxclient.scripts.PacketWatcher.destroy(), and com.realtime.crossfire.jxclient.scripts.PacketWatcher.rebuildPattern().

scriptProcess

final ScriptProcess com.realtime.crossfire.jxclient.scripts.PacketWatcher.scriptProcess

private

The ScriptProcess for sending commands.

Definition at line 56 of file PacketWatcher.java.

Referenced by com.realtime.crossfire.jxclient.scripts.PacketWatcher.PacketWatcher().

---

The documentation for this class was generated from the following file:

• src/gui/src/main/java/com/realtime/crossfire/jxclient/scripts/PacketWatcher.java