net.openhft.chronicle.network

Class ChronicleSocketChannelBuilder

java.lang.Object

net.openhft.chronicle.network.ChronicleSocketChannelBuilder

public class ChronicleSocketChannelBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
ChronicleSocketChannelBuilder(@NotNull InetSocketAddress socketAddress)

Method Summary

Modifier and Type	Method and Description
ChronicleSocketChannelBuilder	localBinding(InetSocketAddress localBinding) Set the local socket to bind to
@Nullable ChronicleSocketChannel	open() Open a socket channel with the builder's current settings
ChronicleSocketChannelBuilder	socketConnectionTimeoutMs(int socketConnectionTimeoutMs) Set the socket connection timeout
ChronicleSocketChannelBuilder	tcpBufferSize(int tcpBufferSize) Set the TCP buffer size
ChronicleSocketChannelBuilder	tcpNoDelay(boolean tcpNoDelay) Set whether to enable/disable Nagle's algorithm for this socket

Methods inherited from class java.lang.Object

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

Constructor Detail

ChronicleSocketChannelBuilder

public ChronicleSocketChannelBuilder(@NotNull
                                     @NotNull InetSocketAddress socketAddress)

Method Detail

tcpBufferSize

public ChronicleSocketChannelBuilder tcpBufferSize(int tcpBufferSize)

Set the TCP buffer size

Parameters:

tcpBufferSize - The TCP buffer size in bytes

Returns:

this

socketConnectionTimeoutMs

public ChronicleSocketChannelBuilder socketConnectionTimeoutMs(int socketConnectionTimeoutMs)

Set the socket connection timeout

Parameters:

socketConnectionTimeoutMs - the socket connection timeout in milliseconds

Returns:

this

tcpNoDelay

public ChronicleSocketChannelBuilder tcpNoDelay(boolean tcpNoDelay)

Set whether to enable/disable Nagle's algorithm for this socket

Parameters:

tcpNoDelay -

Returns:

localBinding

public ChronicleSocketChannelBuilder localBinding(InetSocketAddress localBinding)

Set the local socket to bind to

Parameters:

localBinding - The local socket to bind to, or null to not bind to any local socket

Returns:

this

open

@Nullable
public @Nullable ChronicleSocketChannel open()
                                                throws IOException

Open a socket channel with the builder's current settings

Returns:

The opened channel, or null if no channel could be opened

Throws:

IOException - if something goes wrong opening the channel