.TH "globus_net_manager_signatures" 3 "Version 1.7" "globus_net_manager" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_net_manager_signatures \- Function Signatures
.PP
 \- Net Manager Function Signatures\&.  

.SH SYNOPSIS
.br
.PP
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_pre_listen\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"
.br
.RI "Net Manager Pre-Listen Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_post_listen\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, char **local_contact_out, \fBglobus_net_manager_attr_t\fP **attr_array_out)"
.br
.RI "Net Manager Post-Listen Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_end_listen\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"
.br
.RI "Net Manager End-Listen Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_pre_accept\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"
.br
.RI "Net Manager Pre-Accept Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_post_accept\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"
.br
.RI "Net Manager Post-Accept Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_pre_connect\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, char **remote_contact_out, \fBglobus_net_manager_attr_t\fP **attr_array_out)"
.br
.RI "Net Manager Pre-Connect Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_post_connect\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"
.br
.RI "Net Manager Post-Connect Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_pre_close\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"
.br
.RI "Net Manager Pre-Close Function Signature\&. "
.ti -1c
.RI "typedef globus_result_t(* \fBglobus_net_manager_post_close\fP) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"
.br
.RI "Net Manager Post-Close Function Signature\&. "
.in -1c
.SH "Detailed Description"
.PP 
Net Manager Function Signatures\&. 

Function signatures for the Net Manager interface\&. \fBglobus_net_manager_tutorial\fP 
.SH "Typedef Documentation"
.PP 
.SS "typedef globus_result_t(* globus_net_manager_end_listen) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"

.PP
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\&.
.PP
The network manager is passed the network transport-specific options and contact string for the listener\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIlocal_contact\fP The transport-specific contact string for the listener [in]\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_post_accept) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"

.PP
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\&.
.PP
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\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIlocal_contact\fP The transport-specific contact string for the local side of the connection\&. 
.br
\fIremote_contact\fP The transport-specific contact string for the remote side of the connection\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fIattr_array_out\fP 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()\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_post_close) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"

.PP
Net Manager Post-Close Function Signature\&. A function of this signature, if included in a network manager implementation, is called after closing a connection\&.
.PP
The network manager is passed the network transport-specific options and contact string for both ends of the connection\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIlocal_contact\fP The transport-specific contact string for the local side of the connection\&. 
.br
\fIremote_contact\fP The transport-specific contact string for the remote side of the connection\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_post_connect) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"

.PP
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\&.
.PP
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\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIremote_contact\fP The transport-specific contact string for the remote side of the connection\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fIattr_array_out\fP 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()\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_post_listen) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, char **local_contact_out, \fBglobus_net_manager_attr_t\fP **attr_array_out)"

.PP
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\&.
.PP
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\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIlocal_contact\fP The transport-specific contact string for the listener [in]\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fIlocal_contact_out\fP 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\&. 
.br
\fIattr_array_out\fP 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()\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_pre_accept) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"

.PP
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\&.
.PP
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\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIlocal_contact\fP The transport-specific contact string for the listener\&. 
.br
\fIattr_array\fP A NULL-terminated array of transport attributes associated with the listener\&. 
.br
\fIattr_array_out\fP 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()\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_pre_close) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *local_contact, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"

.PP
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\&.
.PP
The network manager is passed the network transport-specific options and contact string for both ends of the connection\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIlocal_contact\fP The transport-specific contact string for the local side of the connection\&. 
.br
\fIremote_contact\fP The transport-specific contact string for the remote side of the connection\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_pre_connect) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const char *remote_contact, const \fBglobus_net_manager_attr_t\fP *attr_array, char **remote_contact_out, \fBglobus_net_manager_attr_t\fP **attr_array_out)"

.PP
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\&.
.PP
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\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIremote_contact\fP The transport-specific contact string for the remote side of the connection\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fIremote_contact_out\fP 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\&. 
.br
\fIattr_array_out\fP 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()\&. 
.RE
.PP

.SS "typedef globus_result_t(* globus_net_manager_pre_listen) (struct \fBglobus_net_manager_s\fP *manager, const \fBglobus_net_manager_attr_t\fP *manager_attr_array, const char *task_id, const char *transport, const \fBglobus_net_manager_attr_t\fP *attr_array, \fBglobus_net_manager_attr_t\fP **attr_array_out)"

.PP
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\&.
.PP
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\&.
.PP
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\&.
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Pointer to the network manager struct that is being invoked\&. 
.br
\fImanager_attr_array\fP An array of attributes associated with the manager\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fItask_id\fP An application-specific task ID associated with this network operation\&. 
.br
\fItransport\fP The name of the transport associated with this listener\&. 
.br
\fIattr_array\fP An array of transport attributes associated with the listener\&. The end of the array is indicated by an attribute containing a NULL scope\&. 
.br
\fIattr_array_out\fP 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()\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for globus_net_manager from the source code\&.