Package de.esoco.coroutine.step.nio

Class SocketSend

java.lang.Object

org.obrel.core.RelatedObject

de.esoco.coroutine.CoroutineStep<I,O>

de.esoco.coroutine.step.nio.AsynchronousChannelStep<java.nio.ByteBuffer,java.nio.ByteBuffer>

de.esoco.coroutine.step.nio.AsynchronousSocketStep

de.esoco.coroutine.step.nio.SocketSend

All Implemented Interfaces:

de.esoco.lib.property.Fluent<CoroutineStep<java.nio.ByteBuffer,java.nio.ByteBuffer>>, org.obrel.core.FluentRelatable<CoroutineStep<java.nio.ByteBuffer,java.nio.ByteBuffer>>, org.obrel.core.Relatable

public class SocketSend
extends AsynchronousSocketStep

Implements asynchronous writing to a AsynchronousSocketChannel.

Nested Class Summary

Nested classes/interfaces inherited from class de.esoco.coroutine.step.nio.AsynchronousChannelStep

AsynchronousChannelStep.ChannelCallback<V,C extends java.nio.channels.AsynchronousChannel>, AsynchronousChannelStep.ChannelOperation<C extends java.nio.channels.AsynchronousChannel>

Field Summary

Fields inherited from class de.esoco.coroutine.step.nio.AsynchronousSocketStep

SOCKET_CHANNEL

Fields inherited from class de.esoco.coroutine.step.nio.AsynchronousChannelStep

CHANNEL_GROUP

Constructor Summary

Constructors

Constructor	Description
SocketSend(java.util.function.Function<Continuation<?>,java.net.SocketAddress> getSocketAddress)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	performAsyncOperation(int bytesProcessed, java.nio.channels.AsynchronousSocketChannel channel, java.nio.ByteBuffer data, AsynchronousChannelStep.ChannelCallback<java.lang.Integer,java.nio.channels.AsynchronousSocketChannel> callback)	Implementation of the ChannelOperation functional interface method signature.
protected void	performBlockingOperation(java.nio.channels.AsynchronousSocketChannel channel, java.nio.ByteBuffer data)	Must be implemented for the blocking execution of a step.
static SocketSend	sendTo(java.net.SocketAddress socketAddress)
static SocketSend	sendTo(java.util.function.Function<Continuation<?>,java.net.SocketAddress> getSocketAddress)	Suspends until all data from the input ByteBuffer has been sent to a network socket.The buffer must be initialized for sending, i.e. if necessary a call to Buffer.flip() must have been performed.

Methods inherited from class de.esoco.coroutine.step.nio.AsynchronousSocketStep

execute, getSocketAddress, getSocketAddressFactory, getSocketChannel, runAsync

Methods inherited from class de.esoco.coroutine.step.nio.AsynchronousChannelStep

getChannelGroup

Methods inherited from class de.esoco.coroutine.CoroutineStep

runBlocking, terminateCoroutine, toString

Methods inherited from class org.obrel.core.RelatedObject

deleteRelation, get, getRelation, getRelations, notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, set, transform, writeRelations

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.esoco.lib.property.Fluent

_with

Methods inherited from interface org.obrel.core.FluentRelatable

with, with, with

Methods inherited from interface org.obrel.core.Relatable

deleteRelation, deleteRelation, deleteRelations, get, getAll, getOption, getRelation, getRelationCount, getRelations, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, set, set, setOption, streamRelations, transform

Constructor Detail

SocketSend

public SocketSend(java.util.function.Function<Continuation<?>,java.net.SocketAddress> getSocketAddress)

Creates a new instance.

Parameters:

getSocketAddress - A function that provides the target socket address from the current continuation

Method Detail

sendTo

public static SocketSend sendTo(java.util.function.Function<Continuation<?>,java.net.SocketAddress> getSocketAddress)

Suspends until all data from the input ByteBuffer has been sent to a network socket.The buffer must be initialized for sending, i.e. if necessary a call to Buffer.flip() must have been performed.

After the data has been fully sent ByteBuffer.clear() will be invoked on the buffer so that it can be used directly for subsequent writing to it. An example would be a following SocketReceive to implement a request-response scheme.

Parameters:

getSocketAddress - A function that provides the target socket address from the current continuation

Returns:

A new step instance

sendTo

public static SocketSend sendTo(java.net.SocketAddress socketAddress)

See Also:

sendTo(Function)

performAsyncOperation

protected boolean performAsyncOperation(int bytesProcessed,
                                        java.nio.channels.AsynchronousSocketChannel channel,
                                        java.nio.ByteBuffer data,
                                        AsynchronousChannelStep.ChannelCallback<java.lang.Integer,java.nio.channels.AsynchronousSocketChannel> callback)

Description copied from class: AsynchronousSocketStep

Implementation of the ChannelOperation functional interface method signature.

Specified by:

performAsyncOperation in class AsynchronousSocketStep

See Also:

AsynchronousChannelStep.ChannelOperation.execute(int, java.nio.channels.AsynchronousChannel, ByteBuffer, AsynchronousChannelStep.ChannelCallback)

performBlockingOperation

protected void performBlockingOperation(java.nio.channels.AsynchronousSocketChannel channel,
                                        java.nio.ByteBuffer data)
                                 throws java.lang.InterruptedException,
                                        java.util.concurrent.ExecutionException

Must be implemented for the blocking execution of a step. It receives an AsynchronousSocketChannel which must be accessed through the blocking API (like Future.get()).

Specified by:

performBlockingOperation in class AsynchronousSocketStep

Parameters:

channel - The channel to perform the operation on

data - The byte buffer for the operation data

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException