Direct Access Transport Library Functions
datepsetwatermark(3DAT)
NAME
datepsetwatermark - set high watermark on Endpoint
SYNOPSIS
cc [ flag... ] file... -ldat [ library... ]
#include
DATRETURN
datepsetwatermark (
IN DATEPHANDLE ephandle,
IN DATCOUNT softhighwatermark,
IN DATCOUNT hardhighwatermark
)
PARAMETERS
ephandle The handle for an instance of an End-
point.
softhighwatermark The soft high watermark for the
number of Recv buffers consumed by
the Endpoint.
hardhighwatermark The hard high watermark for the
number of Recv buffers consumed by
the Endpoint.
DESCRIPTION
The datepsetwatermark() function sets the soft and hard
high watermark values for EP and arms EP for generating
asynchronous events for high watermarks. An asynchronous
event will be generated for IA asyncevd when the number of
Recv buffers at EP exceeds the soft high watermark for the
first time. A connection broken event will be generated for
EP connectevd when the number of Recv buffers at EP exceeds
the hard high watermark. These can occur during this call or
when EP takes a buffer from the SRQ or EP RQ. The soft and
hard high watermark asynchronous event generation and set-
ting are independent of each other.
The asynchronous event for a soft high watermark is gen-
erated only once per setting. Once an event is generated, no
new asynchronous events for the soft high watermark is gen-
erated until the EP is again set for the soft high water-
mark. If the Consumer is once again interested in the event,
the Consumer should again set the soft high watermark.
SunOS 5.11 Last change: 16 Jul 2004 1
Direct Access Transport Library Functions
datepsetwatermark(3DAT)
If the Consumer is not interested in a soft or hard high
watermark, the value of DATWATERMARKINFINITE can be speci-
fied for the case that is the default value. This value
specifies that a non-asynchronous event will be generated
for a high watermark EP attribute for which this value is
set. It does not prevent generation of a connection broken
event for EP when no Recv buffer is available for a message
arrived on the EP connection.
The operation is supported for all states of Endpoint.
RETURN VALUES
DATSUCES The operation was successful.
DATINVALIDHANDLE The ephandle argument is an
invalid DAT handle.
DATINVALIDPARAMETER One of the parameters is invalid.
DATMODELNOTSUPORTED The requested Model was not sup-
ported by the Provider. The Pro-
vider does not support EP Soft or
Hard High Watermarks.
USAGE
For a hard high watermark, the Provider is ready to generate
a connection broken event as soon as the connection is esta-
blished.
If the asynchronous event for a soft or hard high watermark
has not yet been generated, this call simply modifies the
values for these attributes. The Provider remains armed for
generation of these asynchronous events.
Regardless of whether an asynchronous event for the soft and
hard high watermark has been generated, this operation will
set the generation of an asynchronous event with the
Consumer-provided high watermark values. If the new high
watermark values are below the current number of Receive
DTOs at EP, an asynchronous event will be generated immedi-
ately. Otherwise the old soft or hard (or both) high water-
mark values are simply replaced with the new ones.
SunOS 5.11 Last change: 16 Jul 2004 2
Direct Access Transport Library Functions
datepsetwatermark(3DAT)
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Standard: uDAPL, 1.2
MT-Level Unsafe
SEE ALSO
datepcreate(3DAT), dateprecvquery(3DAT),
datsrqcreate(3DAT), datsrqfree(3DAT),
datsrqpostrecv(3DAT), datsrqquery(3DAT),
datsrqresize(3DAT), datsrqsetlw(3DAT), libdat(3LIB),
attributes(5)
SunOS 5.11 Last change: 16 Jul 2004 3
Direct Access Transport Library Functions
datepsetwatermark(3DAT)
SunOS 5.11 Last change: 16 Jul 2004 4
|
