Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

Attributes and Cntls
[Globus XIO UDP Driver]

Enumerations

Functions


Detailed Description

UDP driver specific attrs and cntls.

See also:
globus_xio_attr_cntl() , globus_xio_handle_cntl() , globus_xio_data_descriptor_cntl()

Enumeration Type Documentation

enum globus_xio_udp_cmd_t
 

UDP driver specific cntls.

Enumeration values:
GLOBUS_XIO_UDP_SET_HANDLE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_SERVICE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_SERVICE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_PORT  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_PORT  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_LISTEN_RANGE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_LISTEN_RANGE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_INTERFACE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_INTERFACE  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_RESTRICT_PORT  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_RESTRICT_PORT  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_REUSEADDR  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_REUSEADDR  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_SET_NO_IPV6  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_NO_IPV6  See usage for: globus_xio_attr_cntl.
GLOBUS_XIO_UDP_GET_HANDLE  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_UDP_SET_SNDBUF  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_UDP_GET_SNDBUF  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_UDP_SET_RCVBUF  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_UDP_GET_RCVBUF  See usage for: globus_xio_attr_cntl, globus_xio_handle_cntl.
GLOBUS_XIO_UDP_GET_CONTACT  See usage for: globus_xio_handle_cntl, globus_xio_data_descriptor_cntl.
GLOBUS_XIO_UDP_GET_NUMERIC_CONTACT  See usage for: globus_xio_handle_cntl, globus_xio_data_descriptor_cntl.
GLOBUS_XIO_UDP_SET_CONTACT  See usage for: globus_xio_data_descriptor_cntl.
GLOBUS_XIO_UDP_CONNECT  See usage for: globus_xio_handle_cntl.
GLOBUS_XIO_UDP_SET_MULTICAST  See usage for: globus_xio_attr_cntl.


Function Documentation

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_SET_HANDLE   ,
globus_xio_system_socket_t    handle
 

Set the udp socket to use.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
handle  Use this handle (fd or SOCKET). Note: close() will not be called on this handle.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_SET_SERVICE   ,
const char *    service_name
 

Set the udp service name to listen on.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
service_name  The service name to use when setting up the listener. If the service name cannot be resolved, the port (if one is set) will be used instead.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_GET_SERVICE   ,
char **    service_name_out
 

Get the service name to listen on.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
service_name_out  A pointer to the service name will be stored here If none is set, NULL will be passed back. Otherwise, the name will be duplicated with strdup() and the user should call free() on it.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_SET_PORT   ,
int    listener_port
 

Set the port number to listen on.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

The default is 0 (system assigned)

Parameters:
listener_port  The port number to use when setting up the listener. If the service name is also set, this will only be used if that can't be resolved.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_GET_PORT   ,
int *    listener_port_out
 

the port number to listen on.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
listener_port_out  The port will be stored here.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_SET_LISTEN_RANGE   ,
int    listener_min_port,
int    listener_max_port
 

Set the port range to confine the listener to.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Used only where no specific service or port has been set. It overrides the range set in the GLOBUS_UDP_PORT_RANGE env variable. If 'restrict port' is true, the listening port will be constrained to the range specified.

Parameters:
listener_min_port  The lower bound on the listener port. (default 0 -- no bound)
listener_max_port  The upper bound on the listener port. (default 0 -- no bound)
See also:
GLOBUS_XIO_UDP_SET_RESTRICT_PORT

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_GET_LISTEN_RANGE   ,
int *    listener_min_port_out,
int *    listener_max_port_out
 

Get the udp port range on an attr.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
listener_min_port_out  The lower bound will be stored here.
listener_max_port_out  The upper bound will be stored here.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_SET_RESTRICT_PORT   ,
globus_bool_t    restrict_port
 

Enable or disable the listener range constraints.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

This enables or ignores the port range found in the attr or in then env. By default, those ranges are enabled.

Parameters:
restrict_port  GLOBUS_TRUE to enable (default), GLOBUS_FALSE to disable.
See also:
GLOBUS_XIO_UDP_SET_LISTEN_RANGE

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_GET_RESTRICT_PORT   ,
globus_bool_t *    restrict_port_out
 

Get the restrict port flag.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
restrict_port_out  The restrict port flag will be stored here.

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_GET_HANDLE   ,
globus_xio_system_socket_t *    handle_out
 

Get the socket handle on an attr or handle.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
handle_out  The udp socket will be stored here. If none is set, GLOBUS_XIO_UDP_INVALID_HANDLE will be set.

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_UDP_GET_HANDLE   ,
globus_xio_system_socket_t *    handle_out
 

Get the socket handle on an attr or handle.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
handle_out  The udp socket will be stored here. If none is set, GLOBUS_XIO_UDP_INVALID_HANDLE will be set.

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_UDP_SET_SNDBUF   ,
int    sndbuf
 

Set the socket send buffer size.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Used to set the size of the send buffer used on the socket.

Parameters:
sndbuf  The send buffer size in bytes to use. (default is system specific)

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_UDP_GET_SNDBUF   ,
int *    sndbuf_out
 

Get the send buffer size on the attr or handle.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters:
sndbuf_out  The send buffer size will be stored here.

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_UDP_GET_CONTACT   ,
char **    contact_string_out
 

Get the contact string associated with a handle or data descriptor.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Use with globus_xio_handle_cntl() to get a contact string for the udp listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read().

Parameters:
contact_string_out  A pointer to a contact string will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>
See also:
GLOBUS_XIO_GET_LOCAL_CONTACT

globus_result_t globus_xio_data_descriptor_cntl dd   ,
driver   ,
GLOBUS_XIO_UDP_GET_CONTACT   ,
char **    contact_string_out
 

Get the contact string associated with a handle or data descriptor.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Use with globus_xio_handle_cntl() to get a contact string for the udp listener. Use with globus_xio_data_descriptor_cntl() to get the sender's contact string from a data descriptor passed to globus_xio_register_read().

Parameters:
contact_string_out  A pointer to a contact string will be stored here. The user should free() it when done with it. It will be in the format: <hostname>:<port>
See also:
GLOBUS_XIO_GET_LOCAL_CONTACT

globus_result_t globus_xio_data_descriptor_cntl dd   ,
driver   ,
GLOBUS_XIO_UDP_SET_CONTACT   ,
char *    contact_string
 

Set the destination contact.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Use on a data descriptor passed to globus_xio_register_write() to specify the recipient of the data. This is necessary with unconnected handles or to send to recipients other than the connected one.

Parameters:
contact_string  A pointer to a contact string of the format <hostname/ip>:<port/service>
See also:
GLOBUS_XIO_UDP_CONNECT

globus_result_t globus_xio_handle_cntl handle   ,
driver   ,
GLOBUS_XIO_UDP_CONNECT   ,
char *    contact_string
 

Set the default destination contact.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Connecting a handle to a specific contact blocks packets from any other contact. It also sets the default destination of all outgoing packets so, using Attributes and Cntls is unnecessary.

Parameters:
contact_string  A pointer to a contact string of the format <hostname/ip>:<port/service>

globus_result_t globus_xio_attr_cntl attr   ,
driver   ,
GLOBUS_XIO_UDP_SET_MULTICAST   ,
char *    contact_string
 

Join a multicast group.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Specifiy a multicast group to join. All packets received will be to the specified multicast address. Do not use Attributes and Cntls, Attributes and Cntls, or pass a contact string on the open. Consider using Attributes and Cntls to allow other apps to join this group. Use Attributes and Cntls to specify the interface to use. Will not affect handles set with Attributes and Cntls. Attributes and Cntls is ignored.

Parameters:
contact_string  A pointer to a contact string of the multicast group to join with the format: <hostname/ip>:<port/service>


about globus | globus toolkit | dev.globus

Comments? webmaster@globus.org