head	1.2;
access;
symbols;
locks; strict;
comment	@# @;


1.2
date	98.10.09.21.25.03;	author milind;	state dead;
branches;
next	1.1;

1.1
date	95.09.25.21.57.19;	author jyelon;	state Exp;
branches;
next	;


desc
@@


1.2
log
@Removed outdated documentation.
@
text
@CALLBOCONCONDITION

NAME
	CallBocOnCondition

SYNOPSIS
	#include "condsend.h"
    #include "chare.h"


	void CallBocOnCondition(boc_fn_ptr, bocNum)
	FUNCTION_PTR boc_fn_ptr;
	int          boc_Num;

DESCRIPTION
    CallBocOnCondition allows the user to periodically call a boc access
    function, presumably to check for some condition and then to act
    accordingly. The user passes in a pointer to a boc access function
    as well as the correct boc number. The system then periodically 
    calls this function. If this function ever returns a non-zero value
    then the system assumes that whatever actions the user wished to
    accomplish in the function (ie a condition has become true and the
    user's program has acted accordingly) have occurred, and the system
    will no longer call the function.

EXAMPLES

SEE ALSO
	CallBocOnCondition()

RESTRICTIONS
    The boc access function (pointed to by boc_fn_ptr) must not take any
    parameters. Once the condition function returns true, the boc access
    function will not be called anymore.

@


1.1
log
@Initial revision
@
text
@@

