hazelcast::client::config::socket_options Class Reference

TCP Socket options. More...

#include <socket_options.h>

Public Member Functions
bool	is_tcp_no_delay () const
	TCP_NODELAY socket option.
socket_options &	set_tcp_no_delay (bool tcp_no_delay)
	Enable/disable TCP_NODELAY socket option.
bool	is_keep_alive () const
	SO_KEEPALIVE socket option.
socket_options &	set_keep_alive (bool keep_alive)
	Enable/disable SO_KEEPALIVE socket option.
bool	is_reuse_address () const
	SO_REUSEADDR socket option.
socket_options &	set_reuse_address (bool reuse_address)
	Enable/disable the SO_REUSEADDR socket option.
int	get_linger_seconds () const
	Gets SO_LINGER with the specified linger time in seconds.
socket_options &	set_linger_seconds (int linger_seconds)
	Enable/disable SO_LINGER with the specified linger time in seconds.
int	get_buffer_size_in_bytes () const
	If set to 0 or less, then it is not set on the socket.
socket_options &	set_buffer_size_in_bytes (int buffer_size)
	If set to 0 or less, then it is not set on the socket.

Static Public Attributes
static const int	KILO_BYTE = 1024
	constant for kilobyte
static const int	DEFAULT_BUFFER_SIZE_BYTE = 128 * KILO_BYTE
	default buffer size of Bytes

Detailed Description

TCP Socket options.

Definition at line 31 of file socket_options.h.

Constructor & Destructor Documentation

socket_options()

hazelcast::client::config::socket_options::socket_options

(

)

Definition at line 514 of file config.cpp.

  : tcp_no_delay_(true)
  , keep_alive_(true)
  , reuse_address_(true)
  , linger_seconds_(3)
  , buffer_size_(DEFAULT_BUFFER_SIZE_BYTE)
{}

Member Function Documentation

get_buffer_size_in_bytes()

int hazelcast::client::config::socket_options::get_buffer_size_in_bytes

(

)

const

If set to 0 or less, then it is not set on the socket.

The default value is DEFAULT_BUFFER_SIZE_BYTE

Gets the SO_SNDBUF and SO_RCVBUF options value in bytes

Returns

bufferSize Number of bytes

Definition at line 575 of file config.cpp.

{
    return buffer_size_;
}

get_linger_seconds()

int hazelcast::client::config::socket_options::get_linger_seconds

(

)

const

Gets SO_LINGER with the specified linger time in seconds.

Returns

lingerSeconds value in seconds

Definition at line 562 of file config.cpp.

{
    return linger_seconds_;
}

is_keep_alive()

bool hazelcast::client::config::socket_options::is_keep_alive

(

)

const

SO_KEEPALIVE socket option.

Returns

true if enabled

Definition at line 536 of file config.cpp.

{
    return keep_alive_;
}

is_reuse_address()

bool hazelcast::client::config::socket_options::is_reuse_address

(

)

const

SO_REUSEADDR socket option.

Returns

true if enabled

Definition at line 549 of file config.cpp.

{
    return reuse_address_;
}

is_tcp_no_delay()

bool hazelcast::client::config::socket_options::is_tcp_no_delay

(

)

const

TCP_NODELAY socket option.

Returns

true if enabled

Definition at line 523 of file config.cpp.

{
    return tcp_no_delay_;
}

set_buffer_size_in_bytes()

socket_options & hazelcast::client::config::socket_options::set_buffer_size_in_bytes

(

int

buffer_size

)

If set to 0 or less, then it is not set on the socket.

The default value is DEFAULT_BUFFER_SIZE_BYTE

Sets the SO_SNDBUF and SO_RCVBUF options to the specified value in bytes

Parameters

bufferSize

Number of bytes

Returns

SocketOptions configured

Definition at line 581 of file config.cpp.

{
    socket_options::buffer_size_ = buffer_size;
    return *this;
}

set_keep_alive()

socket_options & hazelcast::client::config::socket_options::set_keep_alive

(

bool

keep_alive

)

Enable/disable SO_KEEPALIVE socket option.

Parameters

keepAlive

enabled if true

Returns

SocketOptions configured

Definition at line 542 of file config.cpp.

{
    socket_options::keep_alive_ = keep_alive;
    return *this;
}

set_linger_seconds()

socket_options & hazelcast::client::config::socket_options::set_linger_seconds

(

int

linger_seconds

)

Enable/disable SO_LINGER with the specified linger time in seconds.

if set to a value of 0 or less then it is disabled.

Default value is 3.

Parameters

lingerSeconds

value in seconds

Returns

SocketOptions configured

Definition at line 568 of file config.cpp.

{
    socket_options::linger_seconds_ = linger_seconds;
    return *this;
}

set_reuse_address()

socket_options & hazelcast::client::config::socket_options::set_reuse_address

(

bool

reuse_address

)

Enable/disable the SO_REUSEADDR socket option.

Parameters

reuseAddress

enabled if true

Returns

SocketOptions configured

Definition at line 555 of file config.cpp.

{
    socket_options::reuse_address_ = reuse_address;
    return *this;
}

set_tcp_no_delay()

socket_options & hazelcast::client::config::socket_options::set_tcp_no_delay

(

bool

tcp_no_delay

)

Enable/disable TCP_NODELAY socket option.

Parameters

tcpNoDelay

Definition at line 529 of file config.cpp.

{
    socket_options::tcp_no_delay_ = tcp_no_delay;
    return *this;
}

Member Data Documentation

DEFAULT_BUFFER_SIZE_BYTE

const int hazelcast::client::config::socket_options::DEFAULT_BUFFER_SIZE_BYTE = 128 * KILO_BYTE

static

default buffer size of Bytes

Definition at line 42 of file socket_options.h.

KILO_BYTE

const int hazelcast::client::config::socket_options::KILO_BYTE = 1024

static

constant for kilobyte

Definition at line 37 of file socket_options.h.

---

The documentation for this class was generated from the following files:

• hazelcast/include/hazelcast/client/config/socket_options.h
• hazelcast/src/hazelcast/client/config.cpp