From fb983fe3825caf76858e7f4df4b466b7eb447cf3 Mon Sep 17 00:00:00 2001 From: Ralph Lange Date: Fri, 16 Aug 2013 17:00:13 +0200 Subject: [PATCH] CAref: typos, replace ..._event() calls with ..._subscription() (by J. Lewis Muir) --- src/ca/CAref.html | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/ca/CAref.html b/src/ca/CAref.html index bd63bc018..dbde9489f 100644 --- a/src/ca/CAref.html +++ b/src/ca/CAref.html @@ -2320,7 +2320,7 @@ int main ( int argc, char ** argv )

Certain CA client initiated requests asynchronously execute an application supplied call back in the client process when a response arrives. The functions -ca_put_callback, ca_get_callback, and ca_add_event all request notification of +ca_put_callback, ca_get_callback, and ca_create_subscription all request notification of asynchronous completion via this mechanism. The event_handler_args structure is passed by value to the application supplied callback. In this structure the dbr field is a void pointer to any @@ -2679,7 +2679,7 @@ on a channel.

The circuit may be initially connected or disconnected depending on the state of the network and the location of the channel. A channel will only enter -a connected state after server's address is determined, and only if channel +a connected state after the server's address is determined, and only if channel access successfully establishes a virtual circuit through the network to the server. Channel access routines that send a request to a server will return ECA_DISCONNCHID if the channel is currently disconnected.

@@ -2728,7 +2728,7 @@ time.

set this field to nil or 0 if they do not need to have a call back function run in response to each connection state change event.

The following structure is passed by value to the user's - connection connection callback function. The op field will + connection callback function. The op field will be set by the CA client library to CA_OP_CONN_UP when the channel connects, and to CA_OP_CONN_DOWN when the channel disconnects. See ca_puser if the @@ -3056,10 +3056,10 @@ int ca_create_subscription ( chtype TYPE, unsigned long COUNT, invoked whenever the process variable undergoes significant state changes. A significant change can be a change in the process variable's value, alarm status, or alarm severity. In the process control function block database the -deadband field determines the magnitude of a significant change for for the +deadband field determines the magnitude of a significant change for the process variable's value. Each call to this function consumes resources in the client library and potentially a CA server until one of ca_clear_channel or -ca_clear_event is called.

+ca_clear_subscription is called.

Subscriptions may be installed or canceled against both connected and disconnected channels. The specified USERFUNC is called once immediately after @@ -3067,7 +3067,7 @@ the subscription is installed with the process variable's current state if the process variable is connected. Otherwise, the specified USERFUNC is called immediately after establishing a connection (or reconnection) with the process variable. The specified USERFUNC is called immediately with the process -variable's current state from within ca_add_event() if the client and the +variable's current state from within ca_create_subscription() if the client and the process variable share the same address space.

If a subscription is installed on a channel in a disconnected state then the @@ -3125,7 +3125,7 @@ indicating the current state of the channel.

PEVID
This is a pointer to user supplied event id which is overwritten if successful. This event id can later be used to clear a specific - event. This option may may be omitted by passing a nil pointer.
+ event. This option may be omitted by passing a nil pointer.
MASK
@@ -3173,7 +3173,7 @@ int ca_clear_subscription ( evid EVID );

Cancel a subscription.

-

All ca_clear_event() requests such as the above are accumulated (buffered) +

All cancel-subscription requests such as the above are accumulated (buffered) and not forwarded to the server until one of ca_flush_io, ca_pend_io, ca_pend_event, or ca_sg_pend are called. This allows several requests to be efficiently sent together in one message.

@@ -3181,7 +3181,7 @@ efficiently sent together in one message.

Arguments

EVID
-
event id returned by ca_add_event()
+
event id returned by ca_create_subscription()

Returns

@@ -3297,7 +3297,7 @@ activity is processed for TIMEOUT seconds.

background activity is processed.

The ca_pend_event function will not return before the specified -time-out expires and all unfinished channel access labor has been processed, +timeout expires and all unfinished channel access labor has been processed, and unlike ca_pend_io returning from the function does not indicate anything about the status of pending IO requests.

@@ -3934,12 +3934,12 @@ prints diagnostics to standard out.

Examples

void ca_test_event (); 
-status = ca_add_event ( type, chid, ca_test_event, NULL, NULL ); 
+status = ca_create_subscription ( type, chid, ca_test_event, NULL, NULL ); 
 SEVCHK ( status, .... );

See Also

-

ca_add_event()

+

ca_create_subscription()

ca_sg_create()

#include <cadef.h>