VR Juggler Portable Runtime: vpr::SocketBasicOpt Class Reference

vpr::ReturnStatus vpr::SocketBasicOpt::getKeepAlive ( bool & enabled ) [inline]

Definition at line 65 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::keep_alive, vpr::SocketOptions::KeepAlive, and vpr::ReturnStatus::success().

00066    {
00067       vpr::SocketOptions::Data option;
00068       vpr::ReturnStatus retval;
00069 
00070       retval = getOption(vpr::SocketOptions::KeepAlive, option);
00071 
00072       if ( retval.success() )
00073       {
00074          enabled = option.keep_alive;
00075       }
00076 
00077       return retval;
00078    }

vpr::ReturnStatus vpr::SocketBasicOpt::setKeepAlive ( const bool enableVal ) [inline]

Definition at line 83 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::keep_alive, and vpr::SocketOptions::KeepAlive.

00084    {
00085       vpr::SocketOptions::Data option;
00086       option.keep_alive = enableVal;
00087       return setOption(vpr::SocketOptions::KeepAlive, option);
00088    }

vpr::ReturnStatus vpr::SocketBasicOpt::getLingerOnClose	(	bool &	enabled,
		int &	lingerSec
	)			`[inline]`

Definition at line 93 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::linger, and vpr::ReturnStatus::success().

00094    {
00095       vpr::SocketOptions::Data opt;
00096       vpr::ReturnStatus retval;
00097 
00098       retval = getOption(vpr::SocketOptions::Linger, opt);
00099 
00100       if ( retval.success() )
00101       {
00102          enabled   = opt.linger.enabled;
00103          lingerSec = opt.linger.seconds;
00104       }
00105 
00106       return retval;
00107    }

vpr::ReturnStatus vpr::SocketBasicOpt::setLingerOnClose	(	const bool	enableVal,
		const int	lingerSec
	)			`[inline]`

Definition at line 112 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::linger.

00114    {
00115       vpr::SocketOptions::Data opt;
00116 
00117       opt.linger.enabled = enableVal;
00118       opt.linger.seconds = lingerSec;
00119 
00120       return setOption(vpr::SocketOptions::Linger, opt);
00121    }

vpr::ReturnStatus vpr::SocketBasicOpt::getRecvBufferSize ( size_t & size ) [inline]

Definition at line 126 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::recv_buffer_size, vpr::SocketOptions::RecvBufferSize, and vpr::ReturnStatus::success().

00127    {
00128       vpr::SocketOptions::Data opt;
00129       vpr::ReturnStatus retval;
00130 
00131       retval = getOption(vpr::SocketOptions::RecvBufferSize, opt);
00132 
00133       if ( retval.success() )
00134       {
00135          size = opt.recv_buffer_size;
00136       }
00137       else
00138       {
00139          size = 0;
00140       }
00141 
00142       return retval;
00143    }

vpr::ReturnStatus vpr::SocketBasicOpt::setRecvBufferSize ( const Int32 size ) [inline]

Definition at line 148 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::recv_buffer_size, and vpr::SocketOptions::RecvBufferSize.

00149    {
00150       vpr::SocketOptions::Data opt;
00151 
00152       opt.recv_buffer_size = size;
00153 
00154       return setOption(vpr::SocketOptions::RecvBufferSize, opt);
00155    }

vpr::ReturnStatus vpr::SocketBasicOpt::getSendBufferSize ( size_t & size ) [inline]

Definition at line 160 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::send_buffer_size, vpr::SocketOptions::SendBufferSize, and vpr::ReturnStatus::success().

00161    {
00162       vpr::SocketOptions::Data opt;
00163       vpr::ReturnStatus retval;
00164 
00165       retval = getOption(vpr::SocketOptions::SendBufferSize, opt);
00166 
00167       if ( retval.success() )
00168       {
00169          size = opt.send_buffer_size;
00170       }
00171       else
00172       {
00173          size = 0;
00174       }
00175 
00176       return retval;
00177    }

vpr::ReturnStatus vpr::SocketBasicOpt::setSendBufferSize ( const Int32 size ) [inline]

Definition at line 182 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::send_buffer_size, and vpr::SocketOptions::SendBufferSize.

00183    {
00184       vpr::SocketOptions::Data opt;
00185 
00186       opt.send_buffer_size = size;
00187 
00188       return setOption(vpr::SocketOptions::SendBufferSize, opt);
00189    }

vpr::ReturnStatus vpr::SocketBasicOpt::getReuseAddr ( bool & enabled ) [inline]

Definition at line 194 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::reuse_addr, vpr::SocketOptions::ReuseAddr, and vpr::ReturnStatus::success().

00195    {
00196       vpr::SocketOptions::Data option;
00197       vpr::ReturnStatus retval;
00198 
00199       retval = getOption(vpr::SocketOptions::ReuseAddr, option);
00200 
00201       if ( retval.success() )
00202       {
00203          enabled = option.reuse_addr;
00204       }
00205 
00206       return retval;
00207    }

vpr::ReturnStatus vpr::SocketBasicOpt::setReuseAddr ( const bool enableVal ) [inline]

Enables reuse of the address that will be bound by the socket.

Precondition:: The socket has been opened, but bind() has not been called.

Definition at line 214 of file SocketBasicOpt.h.

References vpr::SocketOptions::Data::reuse_addr, and vpr::SocketOptions::ReuseAddr.

Referenced by vpr::SocketAcceptor::open().

00215    {
00216       vpr::SocketOptions::Data option;
00217       option.reuse_addr = enableVal;
00218       return setOption(vpr::SocketOptions::ReuseAddr, option);
00219    }

vpr::SocketBasicOpt Class Reference

Public Member Functions

Detailed Description

Member Function Documentation


Public Member Functions
vpr::ReturnStatus	getKeepAlive (bool &enabled)
vpr::ReturnStatus	setKeepAlive (const bool enableVal)
vpr::ReturnStatus	getLingerOnClose (bool &enabled, int &lingerSec)
vpr::ReturnStatus	setLingerOnClose (const bool enableVal, const int lingerSec)
vpr::ReturnStatus	getRecvBufferSize (size_t &size)
vpr::ReturnStatus	setRecvBufferSize (const Int32 size)
vpr::ReturnStatus	getSendBufferSize (size_t &size)
vpr::ReturnStatus	setSendBufferSize (const Int32 size)
vpr::ReturnStatus	getReuseAddr (bool &enabled)
vpr::ReturnStatus	setReuseAddr (const bool enableVal)
	Enables reuse of the address that will be bound by the socket.