.TH "globus_net_manager_context" 3 "Tue Jul 5 2022" "Version 1.7" "globus_net_manager" \" -*- nroff -*-
.ad l
.nh
.SH NAME
globus_net_manager_context \- Context
.PP
 \- Net Manager Context Management Functions\&.  

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

.in +1c
.ti -1c
.RI "typedef struct globus_i_net_manager_context_s * \fBglobus_net_manager_context_t\fP"
.br
.RI "Net Manager Context\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBglobus_net_manager_context_destroy\fP (\fBglobus_net_manager_context_t\fP context)"
.br
.RI "Destroy Context\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_end_listen\fP (\fBglobus_net_manager_context_t\fP context, const char *task_id, const char *transport, const char *local_contact, const \fBglobus_net_manager_attr_t\fP *attr_array)"
.br
.RI "Call Context End Listen\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_init\fP (\fBglobus_net_manager_context_t\fP *context, const \fBglobus_net_manager_attr_t\fP *attrs)"
.br
.RI "Initialize Context\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_post_accept\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Post Accept\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_post_close\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Post Close\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_post_connect\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Post Connect\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_post_listen\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Post Listen\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_pre_accept\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Pre Accept\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_pre_close\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Pre Close\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_pre_connect\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Pre Connect\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_context_pre_listen\fP (\fBglobus_net_manager_context_t\fP context, 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 "Call Context Pre Listen\&. "
.in -1c
.SH "Detailed Description"
.PP 
Net Manager Context Management Functions\&. 

The Net Manager Context manages a collection of network manager plug-ins which will be called when network events occur\&.
.PP
Initialize the context by calling \fBglobus_net_manager_context_init()\fP\&. This processes an array of attributes\&. The 'scope' member of of attributes indicate the name of a network manager to associate with the context\&. The (name, value) tuples of the attributes are added to the attributes passed to all of that particular network manager's implementation functions\&.
.PP
Once the network manager context is created, pass it to the per-operation invocation functions to trigger all of the manager callouts associated with the context\&.
.PP
When the network manager context is no longer needed, destroy it by calling \fBglobus_net_manager_context_destroy()\fP\&. 
.SH "Typedef Documentation"
.PP 
.SS "typedef struct globus_i_net_manager_context_s* \fBglobus_net_manager_context_t\fP"

.PP
Net Manager Context\&. A structure of this type is used to thread attributes through the set of configured net manager modules and invoke their functions in configuration order\&. 
.SH "Function Documentation"
.PP 
.SS "void globus_net_manager_context_destroy (\fBglobus_net_manager_context_t\fP context)"

.PP
Destroy Context\&. This functions destroys \fIcontext\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP Pointer to the context to destroy\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_end_listen (\fBglobus_net_manager_context_t\fP context, const char * task_id, const char * transport, const char * local_contact, const \fBglobus_net_manager_attr_t\fP * attr_array)"

.PP
Call Context End Listen\&. Call the chain of end_listen() functions in a context with the given task_id, transport, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of the socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the end_listen calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_init (\fBglobus_net_manager_context_t\fP * context, const \fBglobus_net_manager_attr_t\fP * attrs)"

.PP
Initialize Context\&. This functions initializes \fIcontext\fP with the attribute list \fIattrs\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP A pointer to the context to initialize\&. 
.br
\fIattrs\fP An array of attributes to initialize the context with\&. 
.RE
.PP
\fBReturns\fP
.RS 4
On error, the 'context' is set to NULL and this function returns an error object\&. Otherwise this function returns 'GLOBUS_SUCCESS' 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_post_accept (\fBglobus_net_manager_context_t\fP context, 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
Call Context Post Accept\&. Call the chain of post_accept() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&. The attributes are chained through all the calls, with any changed values returned from a manager passed to subsequent managers in the chain\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of the socket\&. 
.br
\fIremote_contact\fP The string representation of the remote address of the socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&. 
.br
\fIattr_array_out\fP The resulting set of attributes from the managers\&. This will be set to NULL if no manager modifies the attributes\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the post_accept calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_post_close (\fBglobus_net_manager_context_t\fP context, 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
Call Context Post Close\&. Call the chain of post_close() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of the socket\&. 
.br
\fIremote_contact\fP The string representation of the remote address of the socket 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the post_close calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_post_connect (\fBglobus_net_manager_context_t\fP context, 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
Call Context Post Connect\&. Call the chain of post_connect() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of the socket\&. 
.br
\fIremote_contact\fP The string representation of the remote address of the socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&. 
.br
\fIattr_array_out\fP The resulting set of attributes from the managers\&. This will be set to NULL if no manager modifies the attributes\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the post_connect calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_post_listen (\fBglobus_net_manager_context_t\fP context, 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
Call Context Post Listen\&. Call the chain of post_listen() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of the socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&. 
.br
\fIlocal_contact_out\fP The resulting local contact from the managers\&. This will be set to NULL if no manager modifies the local contact\&. 
.br
\fIattr_array_out\fP The resulting set of attributes from the managers\&. This will be set to NULL if no manager modifies the attributes\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the post_listen() calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_pre_accept (\fBglobus_net_manager_context_t\fP context, 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
Call Context Pre Accept\&. Call the chain of pre_accept() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&. 
.br
\fIattr_array_out\fP The resulting set of attributes from the managers\&. This will be set to NULL if no manager modifies the attributes\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the pre_accept() calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_pre_close (\fBglobus_net_manager_context_t\fP context, 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
Call Context Pre Close\&. Call the chain of pre_close() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIlocal_contact\fP The string representation of the local address of socket\&. 
.br
\fIremote_contact\fP The string representation of the remote address of socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the pre_close() calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_pre_connect (\fBglobus_net_manager_context_t\fP context, 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
Call Context Pre Connect\&. Call the chain of pre_connect() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIremote_contact\fP The string representation of the remote address of socket\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&. 
.br
\fIremote_contact_out\fP The resulting string representation of the remote address\&. This will be set to NULL if no manager modifies the address\&. 
.br
\fIattr_array_out\fP The resulting set of attributes from the managers\&. This will be set to NULL if no manager modifies the attributes\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the pre_connect() calls stop and the error is returned to the caller\&. 
.RE
.PP

.SS "globus_result_t globus_net_manager_context_pre_listen (\fBglobus_net_manager_context_t\fP context, 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
Call Context Pre Listen\&. Call the chain of pre_listen() functions in a context with the given task_id, transport, contact information, and attributes\&. If any manager in the context returns an error, the subsequent managers will not be called\&.
.PP
\fBParameters\fP
.RS 4
\fIcontext\fP The context to call functions in\&. 
.br
\fItask_id\fP The task_id associated with this network operation\&. 
.br
\fItransport\fP The transport driver associated with this network operation\&. 
.br
\fIattr_array\fP The set of attributes to pass to the managers\&. 
.br
\fIattr_array_out\fP The resulting set of attributes from the managers\&. This will be set to NULL if no manager modifies the attributes\&.
.RE
.PP
\fBReturns\fP
.RS 4
On success, this function returns GLOBUS_SUCCESS\&. If any manager returns an error, the pre_listen() calls stop and the error is returned to the caller\&. 
.RE
.PP

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