ndmprun.l

网络数据管理协议的开发

.\" Copyright (c) 1996,1997 PDC, Network Appliance. All Rights Reserved.
.\" $Id: ndmpRun.l,v 1.3 1997/02/01 09:50:34 tim Exp $
'\"macro stdmacro
.nr X
.TH ndmpRun l "02 Jan 1997"
.SH NAME
ndmpRun \- waits for and accepts NDMP connections
.SH SYNOPSIS
.LP
.nf
.ft 3
#include <ndmp_common.h>
.ft
.fi
.LP
.BI "void ndmpRun(u_long port,"
.if n .ti +5n
.BI "bool_t dofork,"
.if n .ti +5n
.BI "NdmpMsgHandler* msgHandlerTbl,"
.if n .ti +5n
.BI "NdmpConHandlerFunc* conHandlerFunc" );
.SH DESCRIPTION
.B ndmpRun(\|)
does not return except upon detection of a fatal error.
It listens for and accepts NDMP connections from NDMP clients.
After accepting a connection, if
.IR dofork
is TRUE, 
.B ndmpRun(\|)
forks a child process to handle the new connection.
Otherwise, the connection is handled by the parent process
and additional connections will not be accepted until the 
connection has been closed and the connection handler function
has returned.
.IR port
specifies the port number to use for listening for NDMP connections.
If
.IR port
is 0, the port number is looked up in the services database.
.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 handle for the connection.
.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
.IR conHandlerFunc
specifies a connection handler function that is called after a connection 
has been accepted and a process has been forked if
.B dofork
is TRUE.
.IR conHandlerFunc
should perform any required initialization and then repeatedly call 
.B ndmpPoll(\|)
until the connection has been closed.
.IR conHandlerFunc 
should not return until after the connection has been closed.
The prototype for 
.IR conHandlerFunc
is:
.RS
.nf
.ft 3
void conHandlerFunc(NdmpConnection  connection)
.fi
.ft 1
.RE
.LP
.IR connection
is the NDMP connection handle for the new NDMP connection.
.LP
.B ndmpDestroyConnection(\|)
should not be called to destroy
.IR connection.
.B ndmpRun(\|)
will destory the connection handle after
.IR conHandlerFunc
returns.
.SH "RETURN VALUES"
None.
.SH "SEE ALSO"
.BR ndmpPoll (l)