net.sf.eBus.client

Class ServerMessage

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

net.sf.eBus.client.AbstractEBusMessage

net.sf.eBus.client.ServerMessage

All Implemented Interfaces:

Serializable

public final class ServerMessage
extends AbstractEBusMessage
implements Serializable

This message reports the remote Internet address and TCP port of a connection newly accepted by EServer but not yet logged in.

All such messages have the subject /eBus. Subscribe to ServerMessage.class:/eBus to receive this notification.

Note: this notification is published locally only and is not sent to remote eBus applications.

Author:

Charles Rapp

See Also:

ConnectionMessage, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServerMessage.Builder Use this builder to create ServerMessage instances.

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field and Description
static EMessageKey	MESSAGE_KEY The server message key ServerMessage.class:/eBus.

Fields inherited from class net.sf.eBus.client.AbstractEBusMessage

EBUS_SUBJECT, remoteAddress, serverPort

Fields inherited from class net.sf.eBus.messages.EMessage

subject, timestamp

Fields inherited from class net.sf.eBus.messages.EMessageObject

MAX_FIELDS

Constructor Summary

Constructors

Constructor and Description
ServerMessage(InetSocketAddress addr, int port) Deprecated. use ServerMessage.Builder to create server message.
ServerMessage(String subject, long timestamp, InetSocketAddress addr, int port) Deprecated. use ServerMessage.Builder to create server message.

Method Summary

Modifier and Type	Method and Description
static ServerMessage.Builder	builder() Returns a new server message builder instance.

Methods inherited from class net.sf.eBus.client.AbstractEBusMessage

toString

Methods inherited from class net.sf.eBus.messages.EMessage

equals, hashCode, isApplicationMessage, isSystemMessage, key, messageType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MESSAGE_KEY

public static final EMessageKey MESSAGE_KEY

The server message key ServerMessage.class:/eBus. Use this key when opening a system message feed.

Constructor Detail

ServerMessage

@Deprecated
public ServerMessage(InetSocketAddress addr,
                                 int port)
                          throws IllegalArgumentException

Deprecated. use ServerMessage.Builder to create server message.

Creates a new server accepted connection message for the given remote eBus address. The subject is set to "/eBus" and the timestamp to the current time.

Parameters:

addr - the newly accepted remote TCP address.

port - connection accepted on this port.

Throws:

IllegalArgumentException - if addr is null.

ServerMessage

@Deprecated
public ServerMessage(String subject,
                                 long timestamp,
                                 InetSocketAddress addr,
                                 int port)
                          throws IllegalArgumentException

Deprecated. use ServerMessage.Builder to create server message.

Creates a new server message for the given subject, timestamp, and TCP address.

Parameters:

subject - the notification subject. Will always be "/eBus".

timestamp - the notification timestamp.

addr - the newly accepted remote TCP address.

port - connection accepted on this port.

Throws:

IllegalArgumentException - if addr is null.

Method Detail

builder

public static ServerMessage.Builder builder()

Returns a new server message builder instance.

Returns:

message builder instance.