globus_net_manager_signatures(3)

NAME
globus_net_manager_signatures - Net Manager Function Signatures

Function signatures for the Net Manager interface. Net Manager Implementation Tutorial.

SYNOPSIS

  Typedefs

typedef globus_result_t(* globus_net_manager_pre_listen) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)
Net Manager Pre-Listen Function Signature.
typedef globus_result_t(* globus_net_manager_post_listen) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const globus_net_manager_attr_t *attr_array, char **local_contact_out, globus_net_manager_attr_t **attr_array_out)
Net Manager Post-Listen Function Signature.
typedef globus_result_t(* globus_net_manager_end_listen) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const globus_net_manager_attr_t *attr_array)
Net Manager End-Listen Function Signature.
typedef globus_result_t(* globus_net_manager_pre_accept) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)
Net Manager Pre-Accept Function Signature.
typedef globus_result_t(* globus_net_manager_post_accept) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)
Net Manager Post-Accept Function Signature.
typedef globus_result_t(* globus_net_manager_pre_connect) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *remote_contact, const globus_net_manager_attr_t *attr_array, char **remote_contact_out, globus_net_manager_attr_t **attr_array_out)
Net Manager Pre-Connect Function Signature.
typedef globus_result_t(* globus_net_manager_post_connect) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)
Net Manager Post-Connect Function Signature.
typedef globus_result_t(* globus_net_manager_pre_close) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array)
Net Manager Pre-Close Function Signature.
typedef globus_result_t(* globus_net_manager_post_close) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array)
Net Manager Post-Close Function Signature.

Detailed Description

Net Manager Function Signatures

Function signatures for the Net Manager interface. Net Manager Implementation Tutorial.

Typedef Documentation

  typedef globus_result_t(* globus_net_manager_end_listen) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const globus_net_manager_attr_t *attr_array)

Net Manager End-Listen Function Signature. A function of this signature, if included in a network manager implementation, is called when the transport-specific listening port will be closed.

The network manager is passed the network transport-specific options and contact string for the listener.

The globus_net_manager library aborts the closing of the listening port if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_end_listen functions configured for this listener.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    local_contact The transport-specific contact string for the listener [in].
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.

  typedef globus_result_t(* globus_net_manager_post_accept) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)

Net Manager Post-Accept Function Signature. A function of this signature, if included in a network manager implementation, is called after accepting a connection on a transport-specific listening port.

The network manager is passed the network transport-specific options and contact string for both ends of the connection. It may modify the attributes of the local side of the connection.

The globus_net_manager library aborts the accept operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_post_accept functions configured for this connection.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    local_contact The transport-specific contact string for the local side of the connection.
    remote_contact The transport-specific contact string for the remote side of the connection.
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.
    attr_array_out A pointer to an array of transport options to apply to the listener prior to returning it to the service. This may be NULL to indicate no change in the options. If non-NULL, this array must be terminated with an attribute having a NULL scope. The array and the members of the globus_net_manager_attr_t struct will be freed by the globus_net_manager library by calling free().

  typedef globus_result_t(* globus_net_manager_post_close) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array)

Net Manager Post-Close Function Signature. A function of this signature, if included in a network manager implementation, is called after closing a connection.

The network manager is passed the network transport-specific options and contact string for both ends of the connection.

The globus_net_manager library aborts the close operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_pre_close functions configured for this connection.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    local_contact The transport-specific contact string for the local side of the connection.
    remote_contact The transport-specific contact string for the remote side of the connection.
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.

  typedef globus_result_t(* globus_net_manager_post_connect) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)

Net Manager Post-Connect Function Signature. A function of this signature, if included in a network manager implementation, is called after establishing a connection to a transport-specific listener.

The network manager is passed the network transport-specific options and contact string for both ends of the connection. It may modify the attributes of the local side of the connection.

The globus_net_manager library aborts the connect operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_post_connect functions configured for this connection.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    remote_contact The transport-specific contact string for the remote side of the connection.
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.
    attr_array_out A pointer to an array of transport options to apply to the listener prior to returning it to the service. This may be NULL to indicate no change in the options. If non-NULL, this array must be terminated with an attribute having a NULL scope. The array and the members of the globus_net_manager_attr_t struct will be freed by the globus_net_manager library by calling free().

  typedef globus_result_t(* globus_net_manager_post_listen) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const globus_net_manager_attr_t *attr_array, char **local_contact_out, globus_net_manager_attr_t **attr_array_out)

Net Manager Post-Listen Function Signature. A function of this signature, if included in a network manager implementation, is called after the transport-specific listening port has been created.

The network manager is passed the network transport-specific options and contact string for the listener. It may modify either of these before the transport listener is made available to the service which requested the listening port.

The globus_net_manager library aborts the listen operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_post_listen functions configured for this listener.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    local_contact The transport-specific contact string for the listener [in].
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.
    local_contact_out A pointer to the local contact which the network manager wants to return to the service. This may be NULL to indicate no change in the contact. This value will be freed() by the globus_net_manager library.
    attr_array_out A pointer to an array of transport options to apply to the listener prior to returning it to the service. This may be NULL to indicate no change in the options. If non-NULL, this array must be terminated with an attribute having a NULL scope. The array and the members of the globus_net_manager_attr_t struct will be freed by the globus_net_manager library by calling free().

  typedef globus_result_t(* globus_net_manager_pre_accept) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)

Net Manager Pre-Accept Function Signature. A function of this signature, if included in a network manager implementation, is called before accepting a connection on a transport-specific listening port.

The network manager is passed the network transport-specific options and contact string for the listener. It may modify the options before the accept operation is complete.

The globus_net_manager library aborts the accept operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_pre_accept functions configured for this listener.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    local_contact The transport-specific contact string for the listener.
    attr_array A NULL-terminated array of transport attributes associated with the listener.
    attr_array_out A pointer to an array of transport options to apply to the listener prior to returning it to the service. This may be NULL to indicate no change in the options. If non-NULL, this array must be terminated with an attribute having a NULL scope. The array and the members of the globus_net_manager_attr_t struct will be freed by the globus_net_manager library by calling free().

  typedef globus_result_t(* globus_net_manager_pre_close) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const globus_net_manager_attr_t *attr_array)

Net Manager Pre-Close Function Signature. A function of this signature, if included in a network manager implementation, is called prior to closing a connection.

The network manager is passed the network transport-specific options and contact string for both ends of the connection.

The globus_net_manager library aborts the close operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_pre_close functions configured for this connection.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    local_contact The transport-specific contact string for the local side of the connection.
    remote_contact The transport-specific contact string for the remote side of the connection.
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.

  typedef globus_result_t(* globus_net_manager_pre_connect) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const char *remote_contact, const globus_net_manager_attr_t *attr_array, char **remote_contact_out, globus_net_manager_attr_t **attr_array_out)

Net Manager Pre-Connect Function Signature. A function of this signature, if included in a network manager implementation, is called after initiating a connection to a transport-specific listener.

The network manager is passed the network transport-specific options and contact string for both ends of the connection. It may modify the attributes of the local side of the connection.

The globus_net_manager library aborts the connect operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_pre_connect functions configured for this connection.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    remote_contact The transport-specific contact string for the remote side of the connection.
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.
    remote_contact_out A pointer to the remote contact which the network manager wants to connect to. This may be NULL to indicate no change in the contact. This value will be freed() by the globus_net_manager library.
    attr_array_out A pointer to an array of transport options to apply to the listener prior to returning it to the service. This may be NULL to indicate no change in the options. If non-NULL, this array must be terminated with an attribute having a NULL scope. The array and the members of the globus_net_manager_attr_t struct will be freed by the globus_net_manager library by calling free().

  typedef globus_result_t(* globus_net_manager_pre_listen) (struct globus_net_manager_s *manager, const globus_net_manager_attr_t *manager_attr_array, const char *task_id, const char *transport, const globus_net_manager_attr_t *attr_array, globus_net_manager_attr_t **attr_array_out)

Net Manager Pre-Listen Function Signature. A function of this signature, if included in a network manager implementation, is called before the transport-specific listening port has been created.

The network manager is passed the network transport-specific options for the listener. It may modify these before the listener is created by the transport.

The globus_net_manager library aborts the listen operation if this function returns a value other than GLOBUS_SUCCESS. In this case, the globus_net_manager will not call any other globus_net_manager_pre_listen functions configured for this listener.

Parameters:
    manager Pointer to the network manager struct that is being invoked.
    manager_attr_array An array of attributes associated with the manager. The end of the array is indicated by an attribute containing a NULL scope.
    task_id An application-specific task ID associated with this network operation.
    transport The name of the transport associated with this listener.
    attr_array An array of transport attributes associated with the listener. The end of the array is indicated by an attribute containing a NULL scope.
    attr_array_out A pointer to an array of transport options to apply to the listener prior to returning it to the service. This may be NULL to indicate no change in the options. If non-NULL, this array must be terminated with an attribute having a NULL scope. The array and the members of the globus_net_manager_attr_t struct will be freed by the globus_net_manager library by calling free().

Author

Generated automatically by Doxygen for globus_net_manager from the source code.