Package org.jgrapes.net

Class SocketConnectionManager

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.net.SocketConnectionManager

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

Direct Known Subclasses:

SocketConnector, SocketServer

public abstract class SocketConnectionManager
extends Component

Provides a base class for the SocketServer and the SocketConnector.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SocketConnectionManager.SocketChannelImpl

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<SocketConnectionManager.SocketChannelImpl>	channels

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
SocketConnectionManager(Channel componentChannel)	Creates a new server using the given channel.

Method Summary

Modifier and Type	Method	Description
int	bufferSize()	Return the configured buffer size.
ExecutorService	executorService()	Returns the executor service.
void	onOutput(Output<ByteBuffer> event, SocketConnectionManager.SocketChannelImpl channel)	Writes the data passed in the event.
protected boolean	removeChannel(SocketConnectionManager.SocketChannelImpl channel)	Removes the channel from the set of registered channels.
SocketConnectionManager	setBufferSize(int bufferSize)	Sets the buffer size for the send an receive buffers.
SocketConnectionManager	setExecutorService(ExecutorService executorService)	Sets an executor service to be used by the event pipelines that process the data from the network.
String	toString()	If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Field Details

channels

protected final Set<SocketConnectionManager.SocketChannelImpl> channels

Constructor Details

SocketConnectionManager

public SocketConnectionManager(Channel componentChannel)

Creates a new server using the given channel.

Parameters:

componentChannel - the component’s channel

Method Details

setBufferSize

public SocketConnectionManager setBufferSize(int bufferSize)

Sets the buffer size for the send an receive buffers.

If no size is set, a default value of 32768 will be used.

Parameters:

bufferSize - the size to use for the send and receive buffers

Returns:

the socket connection manager for easy chaining

bufferSize

public int bufferSize()

Return the configured buffer size.

Returns:

the bufferSize

setExecutorService

public SocketConnectionManager setExecutorService(ExecutorService executorService)

Sets an executor service to be used by the event pipelines that process the data from the network.

Setting this to an executor service with a limited number of threads allows to control the maximum load from the network.

Parameters:

executorService - the executorService to set

Returns:

the socket connection manager for easy chaining

See Also:

• Manager.newEventPipeline(ExecutorService)

executorService

public ExecutorService executorService()

Returns the executor service.

Returns:

the executorService

onOutput

@Handler
public void onOutput(Output<ByteBuffer> event,
 SocketConnectionManager.SocketChannelImpl channel)
              throws InterruptedException

Writes the data passed in the event.

The end of record flag is used to determine if a channel is eligible for purging. If the flag is set and all output has been processed, the channel is purgeable until input is received or another output event causes the state to be reevaluated.

Parameters:

event - the event

channel - the channel

Throws:

InterruptedException - the interrupted exception

removeChannel

protected boolean removeChannel(SocketConnectionManager.SocketChannelImpl channel)

Removes the channel from the set of registered channels.

Parameters:

channel - the channel

Returns:

true, if channel was registered

toString

public String toString()

Description copied from class: ComponentVertex

If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Overrides:

toString in class ComponentVertex