Package pyGlobus :: Module io :: Class NetIOAttr
[show private | hide private]
[frames | no frames]

Class NetIOAttr

Known Subclasses:
TCPIOAttr

Method Summary
  __init__(self)
  __del__(self)
  get_handle(self)
######################################################################## # XXX This handle is only valid as long as this object exists.
  get_keepalive(self)
Get the NetIOAttr's keepAlive
  get_linger(self)
Query the linger attribute in the specified attribute set.
  get_oobinline(self)
Query the oobinline attribute in the specified attribute set.
  get_rcvbuf(self)
Query the rcvbuf attribute in the specified attribute set.
  get_reuseaddr(self)
Accessor for the NetIOAttr's reuseaddr
  get_sndbuf(self)
Query the sndbuf attribute in the specified attribute set.
  set_keepalive(self, keepAlive)
Set the NetIOAttr's keepAlive
  set_linger(self, linger, lingerTime)
Set the linger attribute in the specified attribute set.
  set_oobinline(self, inline)
Set the oobinline attribute in the specified attribute set.
  set_rcvbuf(self, rcvbuf)
Set the rcvbuf attribute in the specified attribute set.
  set_reuseaddr(self, reuse)
Set the NetIOAttr's reuseaddr
  set_sndbuf(self, sndbuf)
Set the sndbuf attribute in the specified attribute set.

Method Details

get_handle(self)

######################################################################## # XXX This handle is only valid as long as this object exists. When # the object is destroyed, the memory this handle points to is freed. #######################################################################

get_keepalive(self)

Get the NetIOAttr's keepAlive

get_linger(self)

Query the linger attribute in the specified attribute set.

This attribute is used to determine what to do when data is in the socket's buffer when the socket is closed. If linger is set to true, then the close operation will block until the socket buffers are empty, or the linger_time has expired.

**Retuns** Returns the value of the linger attribute, and the time (in seconds) to block at close time if linger is true and data is queed in the socket buffer.

get_oobinline(self)

Query the oobinline attribute in the specified attribute set.

This attribute is used to choose whether out-of-band data is received in the normal data queue, or must be received specially by calling globus_io_recv() or globus_io_register_recv() with the MSG_OOB flag set to true.
Returns:
The value of the oobinline attribute.

get_rcvbuf(self)

Query the rcvbuf attribute in the specified attribute set.

This attribute is used to choose the size of the receive buffer for the socket handle this attribute is applied to. The receive buffer is often used by the operating system to choose the appropriate TCP window size.
Returns:
The value of the receive buffer in bytes.

get_reuseaddr(self)

Accessor for the NetIOAttr's reuseaddr

get_sndbuf(self)

Query the sndbuf attribute in the specified attribute set.

This attribute is used to choose the size of the send buffer for the socket handle this attribute is applied to. The send buffer is often used by the operating system to choose the appropriate TCP window size.
Returns:
The value of the send buffer in bytes.

set_keepalive(self, keepAlive)

Set the NetIOAttr's keepAlive

set_linger(self, linger, lingerTime)

Set the linger attribute in the specified attribute set.

This attribute is used to determine what to do when data is in the socket's buffer when the socket is closed. If linger is set to true, then the close operation will block until the socket buffers are empty, or the linger_time has expired.
Parameters:
linger - The value of the linger attribute.
lingerTime - The time (in seconds) to block at close time if linger is true and data is queued in the socket buffer.
Returns:
None

set_oobinline(self, inline)

Set the oobinline attribute in the specified attribute set.

This attribute is used to choose whether out-of-band data is received in the normal data queue, or must be received specially by calling globus_io_recv() or globus_io_register_recv() with the MSG_OOB flag set to true.
  • *inline* The value of the oobinline attribute.
Returns:
None

set_rcvbuf(self, rcvbuf)

Set the rcvbuf attribute in the specified attribute set.

This attribute is used to choose the size of the receive buffer for the socket handle this attribute is applied to. The receive buffer is often used by the operating system to choose the appropriate TCP window size.
Parameters:
rcvbuf - The value of the receive buffer in bytes.
Returns:
None

set_reuseaddr(self, reuse)

Set the NetIOAttr's reuseaddr

set_sndbuf(self, sndbuf)

Set the sndbuf attribute in the specified attribute set.

This attribute is used to choose the size of the send buffer for the socket handle this attribute is applied to. The send buffer is often used by the operating system to choose the appropriate TCP window size.
Parameters:
sndbuf - The value of the send buffer in bytes.
Returns:
None

Generated by Epydoc 2.1 on Tue Apr 4 14:32:53 2006 http://epydoc.sf.net