diff --git a/src/ca/CAref.html b/src/ca/CAref.html index 5243ba95f..26752d5e2 100644 --- a/src/ca/CAref.html +++ b/src/ca/CAref.html @@ -74,7 +74,7 @@ height="31" width="88">
MatchFrequently vxWorks systems boot by default with routes limiting access only to the local subnet. If a EPICS system is operating in a WAN environment it may be necessary to configure routes into the vxWorks system which enable a vxWorks based CA server to respond to requests originating outside it's -subnet. These routing restrinctions can also apply to vxWorks base CA clients -communicating with off subnet servers. An EPICS system manager can implemnt -an rudamentary, but robust, form of access control for a particular host by +subnet. These routing restrictions can also apply to vxWorks base CA clients +communicating with off subnet servers. An EPICS system manager can implement +an rudimentary, but robust, form of access control for a particular host by not providing routes in that host that reach outside of a limited set of subnets. See "routeLib" in the vxWorks reference manual.
@@ -501,7 +501,7 @@ interval is also dynamically adjusted based on the past success rate.If name resolution requests are not responded to, then the client library doubles the delay between name resolution attempts and reduces the number of requests per interval. The delay between attempts is initially limited by a -maxuimum however, after some long interval, if the client library does not +maximum however, after some long interval, if the client library does not receive any responses it stops sending name resolution attempts altogether until it sees a beacon anomaly.
@@ -533,7 +533,7 @@ beacons are received by the client. all of them to all directly receive a copy of the server beacon messages when the beacon messages are sent to unicast addresses, or when legacy IP kernels are still in use. To avoid confusion over these restrictions a special UDP -server, the CA Repeater, is auotomatically spawned by the CA client library +server, the CA Repeater, is automatically spawned by the CA client library when it is not found to be running. This program listens for server beacons sent to the UDP port specified in the EPICS_CA_REPEATER_PORT parameter and fans any beacons received out to any CA client program running on the same @@ -711,7 +711,7 @@ to, and therefore accept messages only from, a limited set of network interfaces (each specified by it's IP address). Specifically, UDP search messages addressed to both the IP addresses in EPICS_CAS_INTF_ADDR_LIST and also to the broadcast addresses of the corresponding LAN interfaces will be -accepted by the server. By defualt, the CA server is accessible from all +accepted by the server. By default, the CA server is accessible from all network interfaces configured into its host. In R3.14 and previous releases the CA server employed by iocCore does not implemet this feature. @@ -727,7 +727,8 @@ implemet this feature.See also Configuring the Maximum Array Size.
-See also Routing restiction on vxWorks systems.
+See also Routing Restrictions on vxWorks +Systems.
Channel Access Client Library regression test.
-The PV used with the test must be naytive type DBR_DOUBLE or DBR_FLOAT, -and modified only by acctst while the test is running. Therefore, -periodically scanned hardware attached analog input records do not work well. -Test failure is indicated if the program stops prior to printing "test -complete". If unspecified the progress logging level is zero, and no messages -are printed while the test is progressing. If unspecified, the channel -duplication count is 20000. If unspecified, the test repetition count is once -only. If unspecified, preemptive callback is disabled.
+The PV used with the test must be native type DBR_DOUBLE or DBR_FLOAT, and +modified only by acctst while the test is running. Therefore, periodically +scanned hardware attached analog input records do not work well. Test failure +is indicated if the program stops prior to printing "test complete". If +unspecified the progress logging level is zero, and no messages are printed +while the test is progressing. If unspecified, the channel duplication count +is 20000. If unspecified, the test repetition count is once only. If +unspecified, preemptive callback is disabled.
catime <PV name> [channel count] [append number to pv name if true]@@ -772,7 +773,7 @@ channel names in the test are numbered as follows. server is rebooted, network connectivity to a server is reestablished, or if a server's CPU exits a CPU load saturated state. -
CA clients with unresolved channels reset their search request schedualing +
CA clients with unresolved channels reset their search request scheduling timers whenever they see a beacon anomaly.
This program can be useful to verify that configuration problems have not @@ -818,7 +819,7 @@ server's port by running "netstat -a | grep nnn" where nnn is the port number configured in the client. If you do not set EPICS_CA_SERVER_PORT or EPICS_CAS_SERVER_PORT then the default port will be 5064.
-Two servers can run on the same host with the same server port number, but @@ -853,8 +854,8 @@ issue has to date been primarily associated with vxWorks systems where mbuf starvation on earlier vxWorks versions is rumored to lead to permanent IP communications stalls which are resolved only by a system reboot. IP kernels that use mbufs frequently allow the initial and maximum number of mbufs to be -configured. Consult your OS's documenation for configuration procedures which -vary between OS and even between different versions of the same OS.
+configured. Consult your OS's documentation for configuration procedures +which vary between OS and even between different versions of the same OS.#include <stdio.h>
@@ -1084,7 +1085,7 @@ int main ( int argc, char ** argv )
nBytes = dbr_size_n ( DBR_TIME_DOUBLE, elementCount );
pTD = ( struct dbr_time_double * ) malloc ( nBytes );
if ( ! pTD ) {
- fprintf ( stderr, "insufficent memory to complete request\n" );
+ fprintf ( stderr, "insufficient memory to complete request\n" );
return -1;
}
@@ -1190,18 +1191,18 @@ server.
Application programs should assume that CA server may be restarted, and
that network connectivity is transient. When you create a CA channel it's
initial connection state will most commonly be disconnected. If the Process
-Variable's server is available the library will immediatly initiate the
+Variable's server is available the library will immediately initiate the
necessary actions to make a connection with it. Otherwise, the client library
will monitor the state of servers on the network and immediately connect or
reconnect with the process variable's server when it becomes available.
-Two methods may be used to dermine if a channel has connected: the
+
Two methods may be used to determine if a channel has connected: the
application program can block in ca_pend_io, or the application program can
install a connection callback handler when it calls ca_create_channel. The ca_pend_io approach is best suited to simple
-command line programs with a short runtime duration, and the conection
+command line programs with a short runtime duration, and the connection
callback method is best suited to toolkit components with a long runtime
duration. If a connection state change call back function is not
installed when ca_create_channel is called (if a nil function
@@ -1248,10 +1249,10 @@ ca_pend_io(), or ca_sg_block() or alternatively it must call ca_poll() at
least every 100 milli-seconds. In single threaded applications a file
descriptor manager like Xt or the interface described in fdManager.h can be
used to monitor both mouse clicks and also CA's file descriptors so that
-ca_poll() can be called immediatly when CA server messages arrives over the
+ca_poll() can be called immediately when CA server messages arrives over the
network.
-Avoid Emulating Bad Parctices that May Still be
+Avoid Emulating Bad Practices that May Still be
Common
With the embryonic releases of EPICS it was a common practice to examine a
@@ -1299,13 +1300,13 @@ callbacks will be called preemptively from more than one thread.
Arguments
SELECT
- - Specifies if preemptive calback is allowed. If it is allowed your
+
- Specifies if preemptive callback is allowed. If it is allowed your
callbacks might be called when the thread that calls this routine is
not executing in the CA client library. Programmers who are unfamiliar
with mutual exclusion locking in a multi-threaded environment should
specify
ca_disable_preemptive_callback. If
ca_enable_preemptive_callback is specified then CA client background
- activies, such as connection management, will proceed even if the
+ activities, such as connection management, will proceed even if the
thread that calls this routine is not executing in the CA client
library.
@@ -1445,7 +1446,7 @@ any time.
is running on a network or operating system that does not have native
support for prioritized delivery or execution respectively. Specifying
many different priorities within the same program can increase resource
- consutption in the client and the server because an independent virtual
+ consumption in the client and the server because an independent virtual
circuit, and associated data structures, is created for each priority
that is used on a particular server.
@@ -1527,7 +1528,7 @@ back is called only after the initiated
resulting from the initiating write operation complete. If unsuccessful the
call back function is invoked indicating bad status. If the channel
disconnects before a put callback request can be completed, then the client's
-call back function is called with bad status, but this does not gaurantee
+call back function is called with bad status, but this does not guarantee
that the server did not receive and process the request before the
disconnect.
@@ -1535,8 +1536,9 @@ disconnect.
disconnected.
All put requests are accumulated (buffered) and not forwarded to the IOC
-until one of ca_flush_io, ca_pend_io, ca_pend_event, or ca_sg_pend are calle.
-This allows several requests to be efficiently combined into one message.
+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 combined into one
+message.
Arguments
@@ -1661,8 +1663,8 @@ in one message.
USERARG
- - Pointer sized variable retained and then passsed back to user
- supplied call back function above.
+ - Pointer sized variable retained and then passed back to user supplied
+ call back function above.
Returns
@@ -1882,7 +1884,7 @@ immediately without
activities.
The delay specified to ca_pend_io() should take into account worst case
-network delays such as Ethernet collision exponential backoff until
+network delays such as Ethernet collision exponential back off until
retransmission delays which can be quite long on overloaded networks.
Unlike ca_pend_event, this routine will
@@ -2042,14 +2044,14 @@ back.
When an error occurs in the server asynchronous to the clients thread then
information about this type of error is passed from the server to the client
in an exception message. When the client receives this exception message an
-exception handler callbackis called.The default exceptionhandler printsa
+exception handler callback is called.The default exception handler prints a
diagnostic message on the client's standard out and terminates execution if
the error condition is severe.
Note that certain fields in "struct exception_handler_args" are not
applicable in the context of some error messages. For instance, a failed get
-will supply the address in the client taskwhere thereturned value
-wasrequested tobe written. For other failed operations the value of the addr
+will supply the address in the client task where the returned value was
+requested to be written. For other failed operations the value of the addr
field should not be used.
Arguments
@@ -2169,7 +2171,7 @@ specified channel.
PFUNC
- Address of user supplied call back function. A nil pointer uninstalls
- the current handler. The following arguments atre passed by
+ the current handler. The following arguments are passed by
value to the supplied callback handler.
typedef struct ca_access_rights {
unsigned read_access:1;
@@ -2302,7 +2304,7 @@ use at the users discretion.
ca_state()
#include <cadef.h>
enum channel_state {
- cs_never_conn, /* valid chid, server not found or unavaliable */
+ cs_never_conn, /* valid chid, server not found or unavailable */
cs_prev_conn, /* valid chid, previously connected to server */
cs_conn, /* valid chid, connected to server */
cs_closed }; /* channel deleted by user */
@@ -2322,7 +2324,7 @@ IO channel.
Returns
STATE
- - the conection state
+ - the connection state
ca_message()
@@ -2387,7 +2389,7 @@ specified channel and
STRING
- boolean true if the client currently has read access to the specified
- channel and boolean false otherwisex
+ channel and boolean false otherwise
ca_write_access()
@@ -2748,7 +2750,7 @@ reissued.
PVALUE
- A pointer to an application supplied buffer containing the value or
- array of valuesReturns
+ array of values returned
Returns
@@ -2849,7 +2851,7 @@ int ca_context_status ( struct ca_client_context *,
Description
-Prints information about the client context including, at higher intereest
+
Prints information about the client context including, at higher interest
levels, status for each channel.
Arguments
@@ -2908,11 +2910,11 @@ preemptively from more than one thread.
The requested data transfer is greater than available memory or
EPICS_CA_MAX_ARRAY_BYTES
ECA_BADTYPE
- The data type specifed is invalid
+ The data type specified is invalid
ECA_BADSTR
Invalid string
ECA_BADCHID
- Ivalid channel identifier
+ Invalid channel identifier
ECA_BADCOUNT
Invalid element count requested
ECA_PUTFAIL
@@ -2920,7 +2922,7 @@ preemptively from more than one thread.
ECA_GETFAIL
Channel read request failed
ECA_ADDFAIL
- unable to instal subscription request
+ unable to install subscription request
ECA_TIMEOUT
User specified timeout on IO operation expired
ECA_EVDISALLOW