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

.SH SYNOPSIS
.br
.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBAttributes\fP"
.br
.RI "Net Manager Attribute Management Functions\&. "
.ti -1c
.RI "\fBContext\fP"
.br
.RI "Net Manager Context Management Functions\&. "
.ti -1c
.RI "\fBNet Manager Data Types\fP"
.br
.RI "Net Manager Data Types\&. "
.ti -1c
.RI "\fBFunction Signatures\fP"
.br
.RI "Net Manager Function Signatures\&. "
.ti -1c
.RI "\fBPython Module\fP"
.br
.RI "Net Manager Python Module\&. "
.ti -1c
.RI "\fBGlobus XIO Net Manager Driver\fP"
.br
.RI "Net Manager XIO Driver\&. "
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGLOBUS_NET_MANAGER_MODULE\fP"
.br
.RI "Module descriptor\&. "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_register\fP (\fBglobus_net_manager_t\fP *manager, globus_module_descriptor_t *module)"
.br
.RI "Register a network manager\&. "
.ti -1c
.RI "globus_result_t \fBglobus_net_manager_unregister\fP (\fBglobus_net_manager_t\fP *manager)"
.br
.RI "Unregister a network manager\&. "
.in -1c
.SH "Detailed Description"
.PP 
Net Manager API\&. 

This API defines the plug-in points for network manager functionality, as well as functions for registering a particular network manager implementation so that it can be invoked during network events\&.
.PP
To implement a network manager, define a struct \fBglobus_net_manager_s\fP with the functions you want called, and register it by calling \fBglobus_net_manager_register()\fP\&. More details are included in \fBglobus_net_manager_tutorial\fP 
.SH "Macro Definition Documentation"
.PP 
.SS "#define GLOBUS_NET_MANAGER_MODULE"

.PP
Module descriptor\&. The Globus Net Manager uses Grid Community Toolkit module activation and deactivation\&. Before any Net Manager functions can be called, the module must be activated, like this: 
.PP
.nf
globus_module_activate(GLOBUS_NET_MANAGER_MODULE);

.fi
.PP
.PP
This function returns GLOBUS_SUCCESS if the library is successfully initialized\&. Otherwise, an error code is returned, and Net Manager functions should not be subsequently called\&.
.PP
Activations are reference counted, so it is safe to activate the module multiple times or in different modules\&.
.PP
To deactivate Net Manager, call
.PP
.PP
.nf
globus_module_deactivate(GLOBUS_NET_MANAGER_MODULE);
.fi
.PP
.PP
This function should be done once for each time the Net Manager was activated\&. 
.SH "Function Documentation"
.PP 
.SS "globus_result_t globus_net_manager_register (\fBglobus_net_manager_t\fP * manager, globus_module_descriptor_t * module)"

.PP
Register a network manager\&. The \fBglobus_net_manager_register()\fP function adds this network manager to those which will be called by the network manager interface when network events occur\&. This is typically called by the network manager when its module is activated\&. 
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Manager information to register\&. 
.br
\fImodule\fP Module descriptor to register\&. Use GlobusExtensionMyModule(module name) 
.RE
.PP

.SS "globus_result_t globus_net_manager_unregister (\fBglobus_net_manager_t\fP * manager)"

.PP
Unregister a network manager\&. The \fBglobus_net_manager_unregister()\fP function removes this network manager from those which will be called by the network manager interface when network events occur\&. This is typically called by the network manager when its module is deactivated\&. 
.PP
\fBParameters\fP
.RS 4
\fImanager\fP Manager information to unregister\&. 
.RE
.PP

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