com.neeve.link
Interface ILnkRootEndpoint

All Known Subinterfaces:

ILnkSTRRootEndpoint

public interface ILnkRootEndpoint

The Link Tree Root Endpoint interface.

A root endpoint represents the root of a link tree. It is responsible for controlling the read machinery of the tree as well as resolving the read-write threading model that will apply to the endpoints of the tree. This interface forms the base interface for the various types of root endpoints.

Threading:

A root endpoint is generally safe for concurrent access by multiple threads. However, refer to the method documentation and threading documentation of desrivatives of this interface for threading restrictions.

Nested Class Summary

static class

ILnkRootEndpoint.ThreadingModel Endpoint threading models.

Method Summary

ILnkRootEndpoint.ThreadingModel	getThreadingModel() Get the threading model in use by the link tree.
boolean	isReadOperational() Indicates whether the link tree's read machinery is operational.
void	registerMessageFactory(ILnkMessageFactory factory) Register a message factory with a root endpoint.
void	scheduleRead() Schedule a proactive read.

Method Detail

getThreadingModel

ILnkRootEndpoint.ThreadingModel getThreadingModel()

Get the threading model in use by the link tree.

Returns:

Returns the threading model in use by the link tree.

Threading:

This method is safe for concurrent access by multiple threads independent of the threading model of the endpoint's link tree.

isReadOperational

boolean isReadOperational()

Indicates whether the link tree's read machinery is operational.

Returns:

Returns true if the read machinery is operational and false otherwise.

Threading:

This method is safe for concurrent access by multiple threads independent of the threading model of the endpoint's link tree.

registerMessageFactory

void registerMessageFactory(ILnkMessageFactory factory)

Register a message factory with a root endpoint.

This method registers a message factory with a root endpoint. See ILnkMessageFactory for details on how the endpoint uses the message factory. This method can only be invoked prior to the starting of the endpoint's read machinery

scheduleRead

void scheduleRead()
                  throws ELnkOpFailedException

Schedule a proactive read.

Throws:

ELnkOpFailedException - Thrown in case an error was encountered during the scheduling of the read.

This method can be used to proactively try to perform a read without waiting for a read ready event

Threading:

This method is safe for concurrent access by multiple threads independent of the threading model of the endpoint's link tree.