Package org.jgrapes.net

Class SocketConnector

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.net.SocketConnectionManager

org.jgrapes.net.SocketConnector

All Implemented Interfaces:

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

public class SocketConnector
extends SocketConnectionManager

A component that reads from or write to a socket connection.

Nested Class Summary

Nested classes/interfaces inherited from class org.jgrapes.net.SocketConnectionManager

SocketConnectionManager.SocketChannelImpl

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

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.net.SocketConnectionManager

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
SocketConnector()	Creates a new connector, using itself as component channel.
SocketConnector(Channel channel)	Create a new instance using the given channel.

Method Summary

Modifier and Type	Method	Description
void	onClose(Close event)	Shuts down the one of the connections.
void	onOpenConnection(OpenSocketConnection event)	Opens a connection to the end point specified in the event.
void	onRegistered(NioRegistration.Completed event)	Called when the new socket channel has successfully been registered with the nio dispatcher.
SocketConnector	setBufferSize(int size)	Sets the buffer size for the send an receive buffers.

Methods inherited from class org.jgrapes.net.SocketConnectionManager

bufferSize, executorService, onOutput, removeChannel, setExecutorService, toString

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, 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

Constructor Details

SocketConnector

public SocketConnector(Channel channel)

Create a new instance using the given channel.

Parameters:

channel - the component’s channel

SocketConnector

public SocketConnector()

Creates a new connector, using itself as component channel.

Method Details

setBufferSize

public SocketConnector setBufferSize(int size)

Description copied from class: SocketConnectionManager

Sets the buffer size for the send an receive buffers.

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

Overrides:

setBufferSize in class SocketConnectionManager

Parameters:

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

Returns:

the socket connection manager for easy chaining

onOpenConnection

@Handler
public void onOpenConnection(OpenSocketConnection event)

Opens a connection to the end point specified in the event.

Parameters:

event - the event

onRegistered

@Handler(channels=Self.class)
public void onRegistered(NioRegistration.Completed event)
                  throws InterruptedException,
IOException

Called when the new socket channel has successfully been registered with the nio dispatcher.

Parameters:

event - the event

Throws:

InterruptedException - the interrupted exception

IOException - Signals that an I/O exception has occurred.

onClose

@Handler
public void onClose(Close event)
             throws IOException,
InterruptedException

Shuts down the one of the connections.

Parameters:

event - the event

Throws:

IOException - if an I/O exception occurred

InterruptedException - if the execution was interrupted