org.elkoserver.server.context.test

Class ZMQSendTester

java.lang.Object

org.elkoserver.server.context.Mod

org.elkoserver.server.context.test.ZMQSendTester

All Implemented Interfaces:

Cloneable, DispatchTarget, Encodable, ContextMod, ContextShutdownWatcher, ObjectCompletionWatcher

public class ZMQSendTester
extends Mod
implements ContextMod, ObjectCompletionWatcher, ContextShutdownWatcher

Context mod to test ZMQ outbound connections

Constructor Summary

Constructors

Constructor and Description
ZMQSendTester(String address) JSON-driven constructor.

Method Summary

Methods

Modifier and Type	Method and Description
JSONLiteral	encode(EncodeControl control) Encode this mod for transmission or persistence.
void	log(User from, String str) Handle the 'log' verb.
void	noteContextShutdown() Do whatever you want when the context shuts down.
void	objectIsComplete() Do what needs to be done now that you are in a finished object environment.

Methods inherited from class org.elkoserver.server.context.Mod

attachTo, clone, context, ensureHolding, ensureInContext, ensureReachable, ensureSameContext, ensureSameUser, holder, isEphemeral, markAsChanged, markAsEphemeral, object

Methods inherited from class java.lang.Object

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

Constructor Detail

ZMQSendTester

@JSONMethod(value="address")
public ZMQSendTester(String address)

JSON-driven constructor.

Method Detail

encode

public JSONLiteral encode(EncodeControl control)

Encode this mod for transmission or persistence.

Specified by:

encode in interface Encodable

Parameters:

control - Encode control determining what flavor of encoding should be done.

Returns:

a JSON literal representing this mod.

log

@JSONMethod(value="str")
public void log(User from,
                       String str)
         throws MessageHandlerException

Handle the 'log' verb. Logs an arbitrary string to the ZMQ connection

Parameters:

str - String to log

Throws:

MessageHandlerException

objectIsComplete

public void objectIsComplete()

Description copied from interface: ObjectCompletionWatcher

Do what needs to be done now that you are in a finished object environment.

This method will be called automatically by the server's object creation mechanism upon completion of the creation of an object to which the mod implementing this interface is attached.

Note: if an object has more than one mod that implements this interface, the order in which the various mods' implementations of this method will be called is undefined.

Specified by:

objectIsComplete in interface ObjectCompletionWatcher

noteContextShutdown

public void noteContextShutdown()

Description copied from interface: ContextShutdownWatcher

Do whatever you want when the context shuts down.

Whenever a context is about to be shutdown, the server will call this method on all objects that have registered an interest in that context via the context's registerContextShutdownWatcher() method.

Specified by:

noteContextShutdown in interface ContextShutdownWatcher