Module org.refcodes.p2p

Package org.refcodes.p2p

Class AbstractPeer<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>,CONSUMER extends P2PMessageConsumer<MSG,PEER>,PEER extends Peer<LOCATOR,HEADER,TAIL,MSG,ROUTER>,ROUTER extends PeerRouter<LOCATOR,HEADER,TAIL,MSG>>

java.lang.Object

org.refcodes.p2p.AbstractPeer<LOCATOR,HEADER,TAIL,MSG,CONSUMER,PEER,ROUTER>

Type Parameters:

ROUTER - The PeerRouter type to use when routing P2PMessage instances.

LOCATOR - Defines the type of the locators identifying a peer.

HEADER - The P2PHeader defines the static attributes addressed for the target of the P2PMessage (a header might be signed as it is not modified during dispatch).

TAIL - The P2PTail describes the dynamic attributes required during dispatch of a P2PMessage (a tail is modified during dispatch by having the visited hops appended).

MSG - The (sub-)type of the P2PMessage being processed by the according Peer (sub-)type.

All Implemented Interfaces:

org.refcodes.mixin.LocatorAccessor<LOCATOR>, Peer<LOCATOR,HEADER,TAIL,MSG,ROUTER>, PeerRouter<LOCATOR,HEADER,TAIL,MSG>, Terminal<LOCATOR>

public abstract class AbstractPeer<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>,CONSUMER extends P2PMessageConsumer<MSG,PEER>,PEER extends Peer<LOCATOR,HEADER,TAIL,MSG,ROUTER>,ROUTER extends PeerRouter<LOCATOR,HEADER,TAIL,MSG>>
extends Object
implements Peer<LOCATOR,HEADER,TAIL,MSG,ROUTER>

The AbstractPeer class implements the Peer interface and is a concrete implementation of a physical Peer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.LocatorAccessor

org.refcodes.mixin.LocatorAccessor.LocatorBuilder<T extends Object,B extends org.refcodes.mixin.LocatorAccessor.LocatorBuilder<T,B>>, org.refcodes.mixin.LocatorAccessor.LocatorMutator<T extends Object>, org.refcodes.mixin.LocatorAccessor.LocatorProperty<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected LOCATOR	_locator
protected CONSUMER	_messageConsumer
protected Set<ROUTER>	_peerRouter

Constructor Summary

Constructors

Constructor	Description
AbstractPeer(LOCATOR aLocator, CONSUMER aMessageConsumer)	Constructs the Peer instance with the given initial state.

Method Summary

Modifier and Type	Method	Description
boolean	addPeerRouter(ROUTER aPeerRouter)	Adds a PeerRouter to the list of the known PeerRouter instances.
int	getHopCount(LOCATOR aDestination, LOCATOR[] aTrail)	Determines the (nearest) hop count to the given peer.
LOCATOR	getLocator()
Set<ROUTER>	peerRouters()	Retrieves all known (attached) PeerRouter instances.
boolean	removePeerRouter(ROUTER aPeerRouter)	Removes a PeerRouter from the list of the known PeerRouter instances.
void	sendMessage(MSG aMessage)	Passes a message to the given peer.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.p2p.Peer

sendMessage

Methods inherited from interface org.refcodes.p2p.PeerRouter

getHopCount

Field Detail

_locator

protected LOCATOR _locator

_peerRouter

protected Set<ROUTER extends PeerRouter<LOCATOR,HEADER,TAIL,MSG>> _peerRouter

_messageConsumer

protected CONSUMER extends P2PMessageConsumer<MSG,PEER> _messageConsumer

Constructor Detail

AbstractPeer

public AbstractPeer(LOCATOR aLocator,
                    CONSUMER aMessageConsumer)

Constructs the Peer instance with the given initial state. The P2PMessageConsumer is your business logic to be invoked upon receivel of a message.

Parameters:

aLocator - The LOCATOR of the Peer being constructed. Messages targeted to this Peer will be addressed to the given LOCATOR.

aMessageConsumer - The consumer (being the functional P2PMessageConsumer interface) of the P2PMessage instances targeted at this Peer instance.

Method Detail

getLocator

public LOCATOR getLocator()

Specified by:

getLocator in interface org.refcodes.mixin.LocatorAccessor<LOCATOR>

getHopCount

public int getHopCount(LOCATOR aDestination,
                       LOCATOR[] aTrail)
                throws IOException

Determines the (nearest) hop count to the given peer.

Specified by:

getHopCount in interface PeerRouter<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>>

Parameters:

aDestination - The unique ID of the peer for which to get the hop count.

aTrail - The trail of peers already passed (in order to avoid turning circles when determining the hop count).

Returns:

The according hop count or -1 if the targeted peer is unreachable.

Throws:

IOException - thrown in case I/O problems occurred while accessing the mesh.

peerRouters

public Set<ROUTER> peerRouters()

Retrieves all known (attached) PeerRouter instances.

Specified by:

peerRouters in interface Peer<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>,CONSUMER extends P2PMessageConsumer<MSG,PEER>>

Returns:

The known (attached) PeerRouter instances.

addPeerRouter

public boolean addPeerRouter(ROUTER aPeerRouter)

Adds a PeerRouter to the list of the known PeerRouter instances.

Specified by:

addPeerRouter in interface Peer<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>,CONSUMER extends P2PMessageConsumer<MSG,PEER>>

Parameters:

aPeerRouter - The PeerRouter being added.

Returns:

False in case this PeerRouter has already been added.

removePeerRouter

public boolean removePeerRouter(ROUTER aPeerRouter)

Removes a PeerRouter from the list of the known PeerRouter instances.

Specified by:

removePeerRouter in interface Peer<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>,CONSUMER extends P2PMessageConsumer<MSG,PEER>>

Parameters:

aPeerRouter - The PeerRouter to be removed.

Returns:

False in case this PeerRouter has not been added (or already been removed).

sendMessage

public void sendMessage(MSG aMessage)
                 throws NoSuchDestinationException,
                        IOException

Passes a message to the given peer.

Specified by:

sendMessage in interface PeerRouter<LOCATOR,HEADER extends P2PHeader<LOCATOR>,TAIL extends P2PTail<LOCATOR>,MSG extends P2PMessage<LOCATOR,HEADER,?,TAIL>>

Parameters:

aMessage - The message to be passed.

Throws:

NoSuchDestinationException - thrown in case there is none such destination peer.

IOException - thrown in case I/O problems occurred while accessing the mesh.

toString

public String toString()

Overrides:

toString in class Object