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

Class TCPIOAttr

NetIOAttr --+
            |
           TCPIOAttr


Method Summary
  __init__(self, handle)
  __del__(self)
  get_authentication_mode(self)
Query the authentication mode attribute in the specified socket attribute set.
  get_authorization_mode(self)
Query the authorization-mode attribute in the specified socket attribute set.
  get_channel_mode(self)
Set the channel-mode attribute in the specified socket attribute set.
  get_delegation_mode(self)
Set the of the delegation-mode attribute in the specified socket attribute set.
  get_interface(self)
Query the tcp interface attribute in the specified TCP attribute set.
  get_nodelay(self)
Query the nodelay attribute in the specified TCP attribute set.
  get_protection_mode(self)
Query the protection-mode attribute in the specified socket attribute set.
  get_restrict_port(self)
Query the restrict-port attribute in the specified TCP attribute set.
  set_authentication_mode(self, mode, cred)
Set the authentication mode attribute in the specified socket attribute set.
  set_authorization_mode(self, mode, authData)
Set the authorization-mode attribute in the specified socket attribute set.
  set_channel_mode(self, mode)
Set the channel-mode attribute in the specified socket attribute set.
  set_delegation_mode(self, mode)
Set the of the delegation-mode attribute in the specified socket attribute set.
  set_interface(self, interface)
Set the tcp interface attribute in the specified TCP attribute set.
  set_nodelay(self, nodelay)
Set the nodelay attribute in the specified TCP attribute set.
  set_protection_mode(self, mode)
Set the protection-mode attribute in the specified socket attribute set.
  set_restrict_port(self, restrict)
Set the restrict-port attribute in the specified TCP attribute set.
    Inherited from NetIOAttr
  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_authentication_mode(self)

Query the authentication mode attribute in the specified socket attribute set.

This attribute is used to determine whether or not to call the GSSAPI security context establishment functions once a socket connection is established.

If the authentication_mode value is GLOBUS_IO_SECURE_AUTHENTICATION_MODE_NONE, then the channel mode, delegation mode, protection mode, and authorization mode will all be reset to disable all security on the socket attribute set.
Returns:
The authentication mode and associated GSSAPI credential.

get_authorization_mode(self)

Query the authorization-mode attribute in the specified socket attribute set.

This attribute is used to determine what security identities to authorize as the peer to the security handshake done when making an authenticated connection.
Returns:
The value of the authorization-mode attribute. The values for mode are described in the documentation for the globus_io_secure_authorization_mode_t type.

get_channel_mode(self)

Set the channel-mode attribute in the specified socket attribute set.

This attribute is used to determine if any data wrapping should be done on the socket connection. This is required to use the data protection attribute.
Returns:
The value of the channel-mode attribute. The values for mode are described in the documentation for the globus_io_secure_channel_mode_t type.

get_delegation_mode(self)

Set the of the delegation-mode attribute in the specified socket attribute set.

This attribute is used to determine whether the process's credentials should be delegated to the other side of the connection.
Returns:
The value of the delegation-mode attribute. The values for mode are described in the documentation for the globus_io_secure_delegation_mode_t type.

get_interface(self)

Query the tcp interface attribute in the specified TCP attribute set.

This attribute is used to determine whether to bind TCP sockets to a particular interface. This attribute must be set before calling globus_io_tcp_create_listener() or globus_io_tcp_connect().
Returns:
The value of the interface attribute, a string in dotted-ip format (ie "127.0.0.1").

get_nodelay(self)

Query the nodelay attribute in the specified TCP attribute set.

This attribute is used to determine whether or not to disable Nagle's algorithm.
Returns:
The new value of the nodelay attribute.

get_protection_mode(self)

Query the protection-mode attribute in the specified socket attribute set.

This attribute is used to determine if any data protection should be done on the socket connection.
Returns:
The value of the protection mode attribute. The values for mode are described in the documentation for the globus_io_secure_protection_mode_t type.

get_restrict_port(self)

Query the restrict-port attribute in the specified TCP attribute set.

This attribute is used to determine whether or not to use the GLOBUS_TCP_PORT_RANGE environment variable to choose an anonymous port for a TCP listener handle. This attribute may not be applied to an existing TCP handle.
Returns:
The new value of the restrict_port attribute.

set_authentication_mode(self, mode, cred=None)

Set the authentication mode attribute in the specified socket attribute set.

This attribute is used to determine whether or not to call the GSSAPI security context establishment functions once a socket connection is established.

If the authentication_mode value is GLOBUS_IO_SECURE_AUTHENTICATION_MODE_NONE, then the channel mode, delegation mode, protection mode, and authorization mode will all be reset to disable all security on the socket attribute set.
Parameters:
mode - The value of the authentication-mode attribute. The values for mode are described in the documentation for the globus_io_secure_authentication_mode_t type.
cred - A GSSAPI credential to be used when authenticating. If the credential is equal to GSS_C_NO_CREDENTIAL, then Globus I/O will use the process's default credentials.
Returns:
None

set_authorization_mode(self, mode, authData)

Set the authorization-mode attribute in the specified socket attribute set.

This attribute is used to determine what security identities to authorize as the peer to the security handshake done when making an authenticated connection.
Parameters:
mode - The new value of the authorization-mode attribute. The values for mode are described in the documentation for the globus_io_secure_authorization_mode_t type.
authData - A globus_io_secure_authorization_data_t structure containing any additional information necessary to perform the specified type of authorization.
Returns:
None

set_channel_mode(self, mode)

Set the channel-mode attribute in the specified socket attribute set.

This attribute is used to determine if any data wrapping should be done on the socket connection. This is required to use the data protection attribute.
Parameters:
mode - The new value of the channel-mode attribute. The values for mode are described in the documentation for the globus_io_secure_channel_mode_t type.
Returns:
None

set_delegation_mode(self, mode)

Set the of the delegation-mode attribute in the specified socket attribute set.

This attribute is used to determine whether the process's credentials should be delegated to the other side of the connection.
Parameters:
mode - The new value of the delegation-mode attribute. The values for mode are described in the documentation for the globus_io_secure_delegation_mode_t type.
Returns:
None

set_interface(self, interface)

Set the tcp interface attribute in the specified TCP attribute set.

This attribute is used to determine whether to bind TCP sockets to a particular interface. This attribute must be set before calling globus_io_tcp_create_listener() or globus_io_tcp_connect().
Parameters:
interface - The value of the interface attribute. The interface string must be in dotted-ip format (ie "127.0.0.1").
Returns:
None

set_nodelay(self, nodelay)

Set the nodelay attribute in the specified TCP attribute set.

This attribute is used to determine whether or not to disable Nagle's algorithm.
Parameters:
nodelay - The new value of the nodelay attribute.
Returns:
None

set_protection_mode(self, mode)

Set the protection-mode attribute in the specified socket attribute set.

This attribute is used to determine if any data protection should be done on the socket connection.
Parameters:
mode - The new value of the protection mode attribute. The values for mode are described in the documentation for the globus_io_secure_protection_mode_t type.
Returns:
None

set_restrict_port(self, restrict)

Set the restrict-port attribute in the specified TCP attribute set.

This attribute is used to determine whether or not to use the GLOBUS_TCP_PORT_RANGE environment variable to choose an anonymous port for a TCP listener handle. This attribute may not be applied to an existing TCP handle.
Parameters:
restrict - The new value of the restrict_port attribute.
Returns:
None

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