ndmpcreateconnection.l

网络数据管理协议的开发

.\" Copyright (c) 1996,1997 PDC, Network Appliance. All Rights Reserved.
.\" $Id: ndmpCreateConnection.l,v 1.3 1997/02/01 09:50:31 tim Exp $
'\"macro stdmacro
.nr X
.TH ndmpCreateConnection l "02 Jan 1997"
.SH NAME
ndmpCreateConnection \- allocate and initialize an NDMP connection handle
.SH SYNOPSIS
.LP
.nf
.ft 3
#include <ndmp_common.h>
.ft
.fi
.LP
.BI "int ndmpCreateConnection(NdmpMsgHandler*" " msgHandlerTbl" );
.SH DESCRIPTION
.B ndmpCreateConnection(\|)
allocates and initializes an NDMP connection handle used for
creating and managing NDMP connections.
.IR msgHandlerTbl
specifies an array of message handlers defined as follows:
.RS
.nf
.ft 3
typedef struct NdmpMsgHandler
{
    ndmp_message         message;
    NdmpMsgHandlerFunc*  func;
    bool_t               auth_required;
    bool_t               (*xdr_request)();
    int                  sizeof_request;
    bool_t               (*xdr_reply)();
    int                  sizeof_reply;
} NdmpMsgHandler;
.fi
.ft 1
.RE
.LP
.IR message
identifies the NDMP message number.
.IR func
specifies a handler function to be called when the request message
is received. The function has the following prototype:
.RS
.nf
.ft 3
void func(NdmpConnection  connection,
          void*           request);
.fi
.ft 1
.RE
.LP
.IR connection
is the NDMP connection structure returned from a call to
.B ndmpCreateConnection.
.IR request
is a pointer to the body of the received request.
.IR auth_required
indicates if the connection needs to be authorized prior to processing
the request. If 
.IR auth_required
is TRUE and the request is received prior to the connection being
authorized, an NDMP_NOT_AUTHORIZED_ERR is returned to the sender.
.IR xdr_request
specifies the XDR function to be used for encoding/decoding the
request message.
.IR sizeof_request
is the size of the request message body.
.IR xdr_reply
specifies the XDR function to be used for encoding/decoding the
reply message.
.IR sizeof_reply
is the size of the reply message body.
.LP
The last element of the array must be a null entry.
.LP
.B ndmpDestroyConnection
should be called after the connection has been closed to 
deallocate resources.
.SH "RETURN VALUES"
Upon successful completion,
the NDMP connection handle
is returned.
Otherwise, a value of 0 is returned.
.SH "SEE ALSO"
.BR ndmpDestroyConnection (l)