Package org.jgroups.stack

Class RouterStub

java.lang.Object

org.jgroups.blocks.cs.ReceiverAdapter

org.jgroups.stack.RouterStub

All Implemented Interfaces:

java.lang.Comparable<RouterStub>, ConnectionListener, Receiver

public class RouterStub
extends ReceiverAdapter
implements java.lang.Comparable<RouterStub>, ConnectionListener

Client stub that talks to a remote GossipRouter via blocking or non-blocking TCP

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouterStub.CloseListener
static interface	RouterStub.MembersNotification
static interface	RouterStub.StubReceiver

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseServer	client
protected RouterStub.CloseListener	close_listener
protected java.util.Map<java.lang.String,java.util.List<RouterStub.MembersNotification>>	get_members_map
protected IpAddress	local
protected static Log	log
protected RouterStub.StubReceiver	receiver
protected IpAddress	remote
protected int	sock_conn_timeout
protected boolean	tcp_nodelay
protected boolean	use_nio

Constructor Summary

Constructors

Constructor	Description
RouterStub(java.net.InetAddress bind_addr, int bind_port, java.net.InetAddress router_host, int router_port, boolean use_nio, RouterStub.CloseListener l, SocketFactory socketFactory)	Creates a stub to a remote GossipRouter
RouterStub(IpAddress local, IpAddress remote, boolean use_nio, RouterStub.CloseListener l, SocketFactory socketFactory)

Method Summary

Modifier and Type	Method	Description
protected void	_doConnect()
int	compareTo(RouterStub o)
void	connect()
void	connect(java.lang.String group, Address addr, java.lang.String logical_name, PhysicalAddress phys_addr)	Registers mbr with the GossipRouter under the given group, with the given logical name and physical address.
void	connectionClosed(Connection conn)
void	connectionEstablished(Connection conn)
RouterStub.CloseListener	connectionListener()
RouterStub	connectionListener(RouterStub.CloseListener l)
void	destroy()
void	disconnect(java.lang.String group, Address addr)
boolean	equals(java.lang.Object obj)
void	getMembers(java.lang.String group, RouterStub.MembersNotification callback)	Fetches a list of PingData from the GossipRouter, one for each member in the given group.
IpAddress	gossipRouterAddress()
int	hashCode()
boolean	isConnected()
IpAddress	local()
protected void	notifyResponse(java.lang.String group, java.util.List<PingData> list)
void	receive(Address sender, byte[] buf, int offset, int length)	Delivers a message from a given sender to the application
void	receive(Address sender, java.io.DataInput in)
void	receive(Address sender, java.nio.ByteBuffer buf)	The default implementation assumes that ByteBuffer.flip() or ByteBuffer.rewind() was called on buf before invoking this callback
RouterStub.StubReceiver	receiver()
RouterStub	receiver(RouterStub.StubReceiver r)
IpAddress	remote()
protected void	removeResponse(java.lang.String group, RouterStub.MembersNotification notif)
void	sendToAllMembers(java.lang.String group, Address sender, byte[] data, int offset, int length)
void	sendToMember(java.lang.String group, Address dest, Address sender, byte[] data, int offset, int length)
RouterStub	set(java.lang.String attr, java.lang.Object val)
int	socketConnectionTimeout()
RouterStub	socketConnectionTimeout(int timeout)
boolean	tcpNoDelay()
RouterStub	tcpNoDelay(boolean tcp_nodelay)
java.lang.String	toString()
boolean	useNio()
protected void	writeRequest(GossipData req)

Methods inherited from class java.lang.Object

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

Field Detail

client

protected BaseServer client

local

protected final IpAddress local

remote

protected final IpAddress remote

use_nio

protected final boolean use_nio

receiver

protected RouterStub.StubReceiver receiver

close_listener

protected RouterStub.CloseListener close_listener

log

protected static final Log log

sock_conn_timeout

protected int sock_conn_timeout

tcp_nodelay

protected boolean tcp_nodelay

get_members_map

protected final java.util.Map<java.lang.String,java.util.List<RouterStub.MembersNotification>> get_members_map

Constructor Detail

RouterStub

public RouterStub(java.net.InetAddress bind_addr,
                  int bind_port,
                  java.net.InetAddress router_host,
                  int router_port,
                  boolean use_nio,
                  RouterStub.CloseListener l,
                  SocketFactory socketFactory)

Creates a stub to a remote GossipRouter

Parameters:

bind_addr - The local address to bind to. If null, one will be picked

bind_port - The local port. If 0, a random port will be used

router_host - The address of the remote GossipRouter

router_port - The port on which the remote GossipRouter is listening

use_nio - Whether to use blocking or non-blocking IO

l - The RouterStub.CloseListener

RouterStub

public RouterStub(IpAddress local,
                  IpAddress remote,
                  boolean use_nio,
                  RouterStub.CloseListener l,
                  SocketFactory socketFactory)

Method Detail

local

public IpAddress local()

remote

public IpAddress remote()

receiver

public RouterStub receiver(RouterStub.StubReceiver r)

receiver

public RouterStub.StubReceiver receiver()

tcpNoDelay

public boolean tcpNoDelay()

tcpNoDelay

public RouterStub tcpNoDelay(boolean tcp_nodelay)

connectionListener

public RouterStub.CloseListener connectionListener()

connectionListener

public RouterStub connectionListener(RouterStub.CloseListener l)

socketConnectionTimeout

public int socketConnectionTimeout()

socketConnectionTimeout

public RouterStub socketConnectionTimeout(int timeout)

useNio

public boolean useNio()

gossipRouterAddress

public IpAddress gossipRouterAddress()

isConnected

public boolean isConnected()

set

public RouterStub set(java.lang.String attr,
                      java.lang.Object val)

connect

public void connect(java.lang.String group,
                    Address addr,
                    java.lang.String logical_name,
                    PhysicalAddress phys_addr)
             throws java.lang.Exception

Registers mbr with the GossipRouter under the given group, with the given logical name and physical address. Establishes a connection to the GossipRouter and sends a CONNECT message.

Parameters:

group - The group cluster) name under which to register the member

addr - The address of the member

logical_name - The logical name of the member

phys_addr - The physical address of the member

Throws:

java.lang.Exception - Thrown when the registration failed

connect

public void connect()
             throws java.lang.Exception

Throws:

java.lang.Exception

_doConnect

protected void _doConnect()
                   throws java.lang.Exception

Throws:

java.lang.Exception

disconnect

public void disconnect(java.lang.String group,
                       Address addr)
                throws java.lang.Exception

Throws:

java.lang.Exception

destroy

public void destroy()

getMembers

public void getMembers(java.lang.String group,
                       RouterStub.MembersNotification callback)
                throws java.lang.Exception

Fetches a list of PingData from the GossipRouter, one for each member in the given group. This call returns immediately and when the results are available, the RouterStub.MembersNotification.members(List) callback will be invoked.

Parameters:

group - The group for which we need members information

callback - The callback to be invoked.

Throws:

java.lang.Exception

sendToAllMembers

public void sendToAllMembers(java.lang.String group,
                             Address sender,
                             byte[] data,
                             int offset,
                             int length)
                      throws java.lang.Exception

Throws:

java.lang.Exception

sendToMember

public void sendToMember(java.lang.String group,
                         Address dest,
                         Address sender,
                         byte[] data,
                         int offset,
                         int length)
                  throws java.lang.Exception

Throws:

java.lang.Exception

receive

public void receive(Address sender,
                    byte[] buf,
                    int offset,
                    int length)

Description copied from interface: Receiver

Delivers a message from a given sender to the application

Specified by:

receive in interface Receiver

Overrides:

receive in class ReceiverAdapter

Parameters:

sender - The sender of the message

buf - The buffer. An application typically de-serializes data from the buffer into objects used by the application. Note that when receive() returns, it is not safe to use the buffer any longer; if an application needs to use a buffer after this callback returns, it must make a copy.

offset - The offset at which the received data starts

length - The length of the received data

receive

public void receive(Address sender,
                    java.nio.ByteBuffer buf)

Description copied from class: ReceiverAdapter

The default implementation assumes that ByteBuffer.flip() or ByteBuffer.rewind() was called on buf before invoking this callback

Specified by:

receive in interface Receiver

Overrides:

receive in class ReceiverAdapter

Parameters:

sender - The sender of the message

buf - The buffer. An application typically de-serializes data from the buffer into objects used by the application. Note that when receive() returns, it is not safe to use the buffer any longer; if an application needs to use a buffer after this callback returns, it must make a copy.

Note that buf could be a direct ByteBuffer.

receive

public void receive(Address sender,
                    java.io.DataInput in)
             throws java.lang.Exception

Specified by:

receive in interface Receiver

Overrides:

receive in class ReceiverAdapter

Throws:

java.lang.Exception

connectionClosed

public void connectionClosed(Connection conn)

Specified by:

connectionClosed in interface ConnectionListener

connectionEstablished

public void connectionEstablished(Connection conn)

Specified by:

connectionEstablished in interface ConnectionListener

compareTo

public int compareTo(RouterStub o)

Specified by:

compareTo in interface java.lang.Comparable<RouterStub>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeRequest

protected void writeRequest(GossipData req)
                     throws java.lang.Exception

Throws:

java.lang.Exception

removeResponse

protected void removeResponse(java.lang.String group,
                              RouterStub.MembersNotification notif)

notifyResponse

protected void notifyResponse(java.lang.String group,
                              java.util.List<PingData> list)