ndmppoll.l

网络数据管理协议的开发

.\" Copyright (c) 1996,1997 PDC, Network Appliance. All Rights Reserved.
.\" $Id: ndmpPoll.l,v 1.3 1997/02/01 09:50:33 tim Exp $
'\"macro stdmacro
.nr X
.TH ndmpPoll l "02 Jan 1997"
.SH NAME
ndmpPoll \- wait for and dispatch an NDMP message
.SH SYNOPSIS
.LP
.nf
.ft 3
#include <ndmp_common.h>
.ft
.fi
.LP
.BI "int ndmpPoll(NdmpConnection connectionHandle,"
.if n .ti +5n
.BI "bool_t block" );
.SH DESCRIPTION
.B ndmpPoll(\|)
polls for a message on the NDMP connection.
If
.B block
is FALSE,
.B ndmpPoll(\|)
returns immediately if no messages are available.
Otherwise, 
.B ndmpPoll(\|)
waits for a message to be received.
.B ndmpProcessRequests(\|)
is called to process received messages.
.SH "RETURN VALUES"
If a message is processed, a value of 1 is returned.
If not messages are available and
.B block
is FALSE, a value of 0 is returned.
A value of -1 is returned if the connection is no longer established.
.SH "SEE ALSO"
.BR ndmpCreateConnection (l),
.BR ndmpRun (l)