From 6bb071d8428d0bd1f1725b1949b1192be43d59ef Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Wed, 31 Jul 2024 21:48:15 -0700 Subject: [PATCH] 1.3.1-9-gbc6d3cc6 --- .nojekyll | 0 _images/nt_table1.svg | 197 + _images/nt_table2.svg | 179 + _images/nt_table3.svg | 213 + _images/nt_table4.svg | 175 + _sources/building.rst.txt | 101 + _sources/cli.rst.txt | 62 + _sources/client.rst.txt | 310 + _sources/details.rst.txt | 209 + _sources/example.rst.txt | 35 + _sources/index.rst.txt | 60 + _sources/ioc.rst.txt | 185 + _sources/netconfig.rst.txt | 113 + _sources/nt.rst.txt | 113 + _sources/ntscalar.rst.txt | 134 + _sources/overview.rst.txt | 366 + _sources/pvalink.rst.txt | 169 + _sources/qgroup.rst.txt | 257 + _sources/releasenotes.rst.txt | 318 + _sources/server.rst.txt | 93 + _sources/sharedpv.rst.txt | 79 + _sources/source.rst.txt | 69 + _sources/typedef.rst.txt | 78 + _sources/util.rst.txt | 171 + _sources/value.rst.txt | 174 + .../_sphinx_javascript_frameworks_compat.js | 134 + _static/alabaster.css | 701 + _static/basic.css | 900 ++ _static/custom.css | 1 + _static/doctools.js | 156 + _static/documentation_options.js | 14 + _static/favicon.png | Bin 0 -> 1432 bytes _static/file.png | Bin 0 -> 286 bytes _static/forkme_right_darkblue_121621.png | Bin 0 -> 7791 bytes _static/jquery.js | 10907 ++++++++++++++++ _static/language_data.js | 199 + _static/minus.png | Bin 0 -> 90 bytes _static/plus.png | Bin 0 -> 90 bytes _static/pygments.css | 83 + _static/searchtools.js | 577 + _static/sphinx_highlight.js | 152 + _static/underscore.js | 2042 +++ building.html | 218 + cli.html | 183 + client.html | 1273 ++ details.html | 308 + example.html | 446 + genindex.html | 1007 ++ index.html | 341 + ioc.html | 355 + netconfig.html | 250 + nt.html | 375 + ntscalar.html | 327 + objects.inv | Bin 0 -> 17979 bytes overview.html | 443 + pvalink-schema-0.json | 36 + pvalink.html | 331 + qgroup.html | 388 + qsrv2-schema-0.json | 30 + releasenotes.html | 569 + search.html | 139 + searchindex.js | 1 + server.html | 455 + sharedpv.html | 336 + source.html | 685 + typedef.html | 583 + util.html | 821 ++ value.html | 1043 ++ 68 files changed, 30669 insertions(+) create mode 100644 .nojekyll create mode 100644 _images/nt_table1.svg create mode 100644 _images/nt_table2.svg create mode 100644 _images/nt_table3.svg create mode 100644 _images/nt_table4.svg create mode 100644 _sources/building.rst.txt create mode 100644 _sources/cli.rst.txt create mode 100644 _sources/client.rst.txt create mode 100644 _sources/details.rst.txt create mode 100644 _sources/example.rst.txt create mode 100644 _sources/index.rst.txt create mode 100644 _sources/ioc.rst.txt create mode 100644 _sources/netconfig.rst.txt create mode 100644 _sources/nt.rst.txt create mode 100644 _sources/ntscalar.rst.txt create mode 100644 _sources/overview.rst.txt create mode 100644 _sources/pvalink.rst.txt create mode 100644 _sources/qgroup.rst.txt create mode 100644 _sources/releasenotes.rst.txt create mode 100644 _sources/server.rst.txt create mode 100644 _sources/sharedpv.rst.txt create mode 100644 _sources/source.rst.txt create mode 100644 _sources/typedef.rst.txt create mode 100644 _sources/util.rst.txt create mode 100644 _sources/value.rst.txt create mode 100644 _static/_sphinx_javascript_frameworks_compat.js create mode 100644 _static/alabaster.css create mode 100644 _static/basic.css create mode 100644 _static/custom.css create mode 100644 _static/doctools.js create mode 100644 _static/documentation_options.js create mode 100644 _static/favicon.png create mode 100644 _static/file.png create mode 100644 _static/forkme_right_darkblue_121621.png create mode 100644 _static/jquery.js create mode 100644 _static/language_data.js create mode 100644 _static/minus.png create mode 100644 _static/plus.png create mode 100644 _static/pygments.css create mode 100644 _static/searchtools.js create mode 100644 _static/sphinx_highlight.js create mode 100644 _static/underscore.js create mode 100644 building.html create mode 100644 cli.html create mode 100644 client.html create mode 100644 details.html create mode 100644 example.html create mode 100644 genindex.html create mode 100644 index.html create mode 100644 ioc.html create mode 100644 netconfig.html create mode 100644 nt.html create mode 100644 ntscalar.html create mode 100644 objects.inv create mode 100644 overview.html create mode 100644 pvalink-schema-0.json create mode 100644 pvalink.html create mode 100644 qgroup.html create mode 100644 qsrv2-schema-0.json create mode 100644 releasenotes.html create mode 100644 search.html create mode 100644 searchindex.js create mode 100644 server.html create mode 100644 sharedpv.html create mode 100644 source.html create mode 100644 typedef.html create mode 100644 util.html create mode 100644 value.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/_images/nt_table1.svg b/_images/nt_table1.svg new file mode 100644 index 000000000..a04df12db --- /dev/null +++ b/_images/nt_table1.svg @@ -0,0 +1,197 @@ + + + + + + + + + record(aai, "TST:Labels_") { field(FTVL, "STRING") field(NELM, "2") field(INP , {const: ["Label A", "Label B"]}) info(Q:group, { "TST:Tbl":{ +id:"epics:nt/NTTable:1.0", "labels":{+type: "plain", +channel: "VAL"} } })}record(aao, "TST:A") { ... }record(aao, "TST:B") { ... }record(longout, "TST:Save") { ... } + TST:Tbl epics:nt/NTTable:1.0 structure record structure _options boolean atomic true alarm_t alarm INVALID DRIVER UDF int severity 3 int status 2 string message UDF time_t timeStamp <undefined> long secondsPastEpoch 631152000 int nanoseconds 0 int userTag 0 string[] labels ["Label A", "Label B"] structure value double[] A [] double[] B [] + + + + + diff --git a/_images/nt_table2.svg b/_images/nt_table2.svg new file mode 100644 index 000000000..a66178875 --- /dev/null +++ b/_images/nt_table2.svg @@ -0,0 +1,179 @@ + + + + + + + + + record(aai, "TST:Labels_") { ... }record(aao, "TST:A") { field(FTVL, "DOUBLE") field(NELM, "10") info(Q:group, { "TST:Tbl":{ "value.A":{+type: "plain", +channel: "VAL", +putorder: 0} } })}record(aao, "TST:B") { ... }record(longout, "TST:Save") { ... } + TST:Tbl epics:nt/NTTable:1.0 structure record structure _options boolean atomic true alarm_t alarm INVALID DRIVER UDF int severity 3 int status 2 string message UDF time_t timeStamp <undefined> long secondsPastEpoch 631152000 int nanoseconds 0 int userTag 0 string[] labels ["Label A", "Label B"] structure value double[] A [] double[] B [] + + + + diff --git a/_images/nt_table3.svg b/_images/nt_table3.svg new file mode 100644 index 000000000..241602073 --- /dev/null +++ b/_images/nt_table3.svg @@ -0,0 +1,213 @@ + + + + + + + + + record(aai, "TST:Labels_") { ... }record(aao, "TST:A") { ... }record(aao, "TST:B") { field(FTVL, "DOUBLE") field(NELM, "10") info(Q:group, { "TST:Tbl":{ "":{+type:"meta", +channel: "VAL"}, "value.B":{+type: "plain", +channel: "VAL", +putorder: 1} } })}record(longout, "TST:Save") { ... } + TST:Tbl epics:nt/NTTable:1.0 structure record structure _options boolean atomic true alarm_t alarm INVALID DRIVER UDF int severity 3 int status 2 string message UDF time_t timeStamp <undefined> long secondsPastEpoch 631152000 int nanoseconds 0 int userTag 0 string[] labels ["Label A", "Label B"] structure value double[] A [] double[] B [] + + + + + + diff --git a/_images/nt_table4.svg b/_images/nt_table4.svg new file mode 100644 index 000000000..ea6efb1bc --- /dev/null +++ b/_images/nt_table4.svg @@ -0,0 +1,175 @@ + + + + + + + + + record(aai, "TST:Labels_") { ... }record(aao, "TST:A") { ... }record(aao, "TST:B") { ... }record(longout, "TST:Save") { field(MDEL, "-1") field(TPRO, "1") info(Q:group, { "TST:Tbl":{ "_save":{+type: "proc", +channel: "VAL", +putorder: 2, +trigger: "*"} } })} + TST:Tbl epics:nt/NTTable:1.0 structure record structure _options boolean atomic true alarm_t alarm INVALID DRIVER UDF int severity 3 int status 2 string message UDF time_t timeStamp <undefined> long secondsPastEpoch 631152000 int nanoseconds 0 int userTag 0 string[] labels ["Label A", "Label B"] structure value double[] A [] double[] B [] + + + diff --git a/_sources/building.rst.txt b/_sources/building.rst.txt new file mode 100644 index 000000000..e4df2d5a3 --- /dev/null +++ b/_sources/building.rst.txt @@ -0,0 +1,101 @@ +.. _building: + +Building from Source +==================== + +Begin be fetching all needed source. :: + + git clone --recursive https://github.com/epics-base/pvxs.git + git clone --branch 7.0 https://github.com/epics-base/epics-base.git + +Prepare the PVXS source tree with the location of epics-base: :: + + cat < pvxs/configure/RELEASE.local + EPICS_BASE=\$(TOP)/../epics-base + EOF + +Build Base: :: + + make -C epics-base + +Alternatives to install or build libevent >=2.0 . + +On RHEL7 and later. :: + + yum install libevent-devel + +On RHEL6 and earlier. :: + + yum install libevent2-devel + +On Debian/Ubuntu. :: + + apt-get install libevent-dev + +To build from source (Requires `CMake `_): :: + + make -C pvxs/bundle libevent # implies .$(EPICS_HOST_ARCH) + +For additional archs: eg. :: + + make -C pvxs/bundle libevent.linux-x86_64-debug + +Finally, build PVXS: :: + + make -C pvxs + +.. _runtests: + +Running Tests +^^^^^^^^^^^^^ + +It is recommended to run automatic unittests when building a new (to you) version +of PVXS, or building on a new host. :: + + make -C pvxs runtests + +Cross-compiling libevent2 +^^^^^^^^^^^^^^^^^^^^^^^^^ + +The bundled libevent may be built for some cross compile targets. +Currently only cross mingw. :: + + make -C pvxs/bundle libevent.windows-x64-mingw + +.. _includepvxs: + +Including PVXS in your application +================================== + +Including PVXS in an application/IOC using the EPICS Makefiles is straightforward. +Add PVXS to the application configure/RELEASE or RELEASE.local file. :: + + cat <> configure/RELEASE.local + PVXS=/path/to/your/build/of/pvxs + EPICS_BASE=/path/to/your/build/of/epics-base + EOF + +Then add the pvxs and pvxsIoc libraries as a dependencies to your IOC or support module. eg. :: + + PROD_IOC += myioc + ... + myioc_DBD += pvxsIoc.dbd + ... + myioc_LIBS += pvxsIoc pvxs + myioc_LIBS += $(EPICS_BASE_IOC_LIBS) + +The "pvxsIoc" library should only be included for IOCs. +It can, and should, be omitted for standalone applications +(eg. GUI clients). + +Add the pvxs library as a dependency to your executable or library. eg. :: + + PROD_IOC += myapp + ... + myapp_LIBS += pvxs + myapp_LIBS += Com + +libevent will be automatically added for linking. + +For those interested, this is accomplished with the logic found in +"cfg/CONFIG_PVXS_MODULE". diff --git a/_sources/cli.rst.txt b/_sources/cli.rst.txt new file mode 100644 index 000000000..d7abd3c1d --- /dev/null +++ b/_sources/cli.rst.txt @@ -0,0 +1,62 @@ +Command Line Tools +================== + +A basic set of command line tools are currently provided to facilitate testing and development. +End users should prefer the CLI tools from the `pvAccessCPP `_ module +for day to day use. + +* ``pvxcall`` - analogous to ``pvcall`` +* ``pvxget`` - analogous to ``pvget`` +* ``pvxinfo`` - analogous to ``pvinfo`` +* ``pvxmonitor`` - analogous to ``pvmonitor`` or ``pvget -m`` +* ``pvxput`` - analogous to ``pvput`` +* ``pvxvct`` - UDP search/beacon Troubleshooting tool. + +Troubleshooting with Virtual Cable Tester +----------------------------------------- + +The ``pvxvct`` executable is capable of listening for UDP searches from PVA clients, +and/or UDP beacons from PVA servers. +Together with ``pvxget`` they can be used to investigate communications issues. + +On the host with the PVA server (IOC or otherwise), +run the following to listen for searches. :: + + $ pvxvct -C -P my:random:test:pvname + +While this is running, switch to the host where the PVA client resides +and run :: + + $ pvxget my:random:test:pvname + +If all goes well, the pvxvct process should print several lines +as search requests are received. eg. :: + + $ pvxvct -C -P my:random:test:pvname + 2020-04-09T19:37:01.146272170 INFO pvxvct 192.168.1.1:47357 Searching for: + 2020-04-09T19:37:01.146442772 INFO pvxvct "my:random:test:pvname" + ... + +Note that pvxvct does not use the ``$EPICS_PVA*`` environment variables +and by default listens on ``0.0.0.0:5076``. Sites using a non-default +port will need to add ``-B 0.0.0.0:``. + +If searches are not seen, then investigate client :ref:`clientconf` +(``$EPICS_PVA*`` environment variables), and firewall settings. + +If searches are seen, then switch to ``pvxget -d ...`` and a real PV name. +The output will be very verbose. Look for lines like the following: :: + + $ pvxget -d my:real:pv:name + ... + 2020-04-09T19:44:46.064937960 DEBUG pvxs.client.io UDP search Rx 53 from 192.168.1.1:5076 + 2020-04-09T19:44:46.064947396 DEBUG pvxs.client.io Search reply for my:real:pv:name + 2020-04-09T19:44:46.065151400 DEBUG pvxs.client.io Connecting to 192.168.1.1:5075 + 2020-04-09T19:44:46.065200101 DEBUG pvxs.client.io Connected to 192.168.1.1:5075 + ... + 2020-04-09T19:44:46.067255960 DEBUG pvxs.client.io Server 192.168.1.1:5075 accepts auth + +Repeat with ``pvxinfo`` in place of ``pvxget``. + +If the ``...accepts auth...`` line is seen, but no subsequent error message, +then see :ref:`reportbug` and attach the output of ``pvxget -d ...``. diff --git a/_sources/client.rst.txt b/_sources/client.rst.txt new file mode 100644 index 000000000..03283203b --- /dev/null +++ b/_sources/client.rst.txt @@ -0,0 +1,310 @@ +.. _clientapi: + +Client API +========== + +`pvxs::client::Context` represents a PVA protocol client. :: + + #include + namespace pvxs { namespace client { ... } } + +.. _clientconf: + +Configuration +------------- + +The recommended starting point is creating new context configured from ``EPICS_PVA_*`` :ref:`environ`. +Use `pvxs::client::Context::fromEnv`. + +EPICS_PVA_ADDR_LIST + A list of destination addresses to which UDP search messages will be sent. + May contain unicast and/or broadcast addresses. + +EPICS_PVA_AUTO_ADDR_LIST + If "YES" then all local broadcast addresses will be implicitly appended to $EPICS_PVA_ADDR_LIST + "YES" if unset. + +EPICS_PVA_NAME_SERVERS + A list of the addresses of listening TCP sockets to which search messages will be sent. + +EPICS_PVA_BROADCAST_PORT + Default UDP port to which UDP searches will be sent. 5076 if unset. + +EPICS_PVA_CONN_TMO + Inactivity timeout for TCP connections. For compatibility with pvAccessCPP + a multiplier of 4/3 is applied. So a value of 30 results in a 40 second timeout. + Prior to 0.2.0 this variable was ignored. + +.. versionadded:: 0.3.0 + **EPICS_PVA_ADDR_LIST** may contain IPv4 multicast, and IPv6 uni/multicast addresses. + +.. versionadded:: 0.2.0 + Added **EPICS_PVA_NAME_SERVERS**. + +.. versionadded:: 0.2.0 + Prior to 0.2.0 *EPICS_PVA_CONN_TMO* was ignored. + +.. code-block:: c++ + + using namespace pvxs; + // Context configured from process environment + client::Context ctxt = client::Context::fromEnv(); + +Programmatic configuration can be accomplished by explicitly filling in a `pvxs::client::Config`. + +Making Requests +--------------- + +A `pvxs::client::Context` instance is the entry point for all client network operations. +Begin by calling one of the info(), get(), put(), rpc(), or monitor() methods. +Each of these methods returns a \*Builder object which can +be used to provide additional configuration in what are in +effected named arguments. + +.. doxygenclass:: pvxs::client::Context + :members: + +.. _clientgetapi: + +Get/Info +^^^^^^^^ + +`pvxs::client::Context::info` and `pvxs::client::Context::get` return a +`pvxs::client::GetBuilder` to prepare either a get() or info() (GET_FIELD) +operation. The practical difference being that info() yields a Value +which will never have any fields marked. + +.. doxygenclass:: pvxs::client::GetBuilder + :members: + +.. _clientputapi: + +Put +^^^ + +`pvxs::client::Context::put` returns a +`pvxs::client::PutBuilder` to prepare a put() operation. +In the generic form of put(), the field values to sent have +to be passed to the builder callback. +This is necessary as the server mandated PV type definition +is not known when a Put operation is initiated. + +Additionally, a put operation will by default first fetch the +present value of the PV and provide it to the builder callback. +This allows eg. to perform string to index lookup when writing +to an NTEnum. + +.. doxygenclass:: pvxs::client::PutBuilder + :members: + +.. _clientrpcapi: + +RPC +^^^ + +`pvxs::client::Context::rpc` returns a +`pvxs::client::RPCBuilder` to prepare an rpc() operation. +There are two ways to prepare the arguments of an RPC operation. + +The recommended way is to use the one argument form of rpc() +and zero or more calls to `pvxs::client::RPCBuilder::arg` +to set argument names and values. +These will be combined into a single argument structure +conforming to the `pvxs::nt::NTURI` convention. + +Alternately, the two argument form of rpc() accepts are +arbitrary Value which is passed to the server unaltered. + +.. doxygenclass:: pvxs::client::RPCBuilder + :members: + +Operation and Result +^^^^^^^^^^^^^^^^^^^^ + +The exec() method of the \*Builder objects returns a ``shared_ptr`` +to an `pvxs::client::Operation` handle, which represents the +in-progress network operation. The caller **must** retain this +handle until completion, or the operation will be implicitly +cancelled. + +When an Operation completes, a `pvxs::client::Result` is passed +to the result() callback. This object holds either a `pvxs::Value` +if the operation succeeded, or an exception. + +.. doxygenstruct:: pvxs::client::Operation + :members: + +.. doxygenclass:: pvxs::client::Result + :members: + +.. _clientmonapi: + +Monitor +^^^^^^^ + +`pvxs::client::Context::monitor` returns a +`pvxs::client::MonitorBuilder` to prepare a MONITOR operation. +The result of this preparation is a `pvxs::client::Subscription` +which represents the in-progress network operation. +The caller **must** retain this handle or the operation will be implicitly cancelled. + +Until cancelled, a Subscription will attempt to (re)connect to the requested PV. + +A Subscription object allows access to a queue of data updates as Value and events/errors as exceptions. +The `pvxs::client::Subscription::pop` method will remove an entry from the queue, or return an empty/invalid Value. +Data updates are returned as a valid Value. +Events/errors are thrown as exceptions. + +An `pvxs::client::MonitorBuilder::event` callback is only invoked when the +Subscription queue becomes not-empty. +It will not be called again until `pvxs::client::Subscription::pop` has returned +an empty/invliad Value. + +The special exceptions `pvxs::client::Connected`, `pvxs::client::Disconnect`, and `pvxs::client::Finished` +have specific meaning when thrown by `pvxs::client::Subscription::pop`. + +Connected + Depending on `pvxs::client::MonitorBuilder::maskConnected` (default true). + Queued when a Subscription becomes connected. + The Connected object include the server host:port as well as a (client) time of connection. + +Disconnect + Depending on `pvxs::client::MonitorBuilder::maskDisconnected` (default false). + Queued when a Subscription becomes disconnected. + +Finished + Depending on `pvxs::client::MonitorBuilder::maskDisconnected` (default false). + Queued when the server indicates that Subscription will receive no more date updates as a normal completion. + Finished is a sub-class of Disconnect. + +There are several aspects of a Subscription which may be selected through the MonitorBuilder. +The special `pvxs::client::Connected` and `pvxs::client::Disconnect` "errors" may appear in +the event queue + +.. doxygenclass:: pvxs::client::MonitorBuilder + :members: + +.. doxygenstruct:: pvxs::client::Subscription + :members: + +Connect +^^^^^^^ + +Request that a Channel be created now which may be used by other Operations, +allowing them to complete more quickly. + +.. doxygenclass:: pvxs::client::ConnectBuilder + :members: + +.. doxygenstruct:: pvxs::client::Connect + :members: + +Threading +^^^^^^^^^ + +A client Context will invoke user callback functions from one or more internal worker threads. +However, it is guaranteed that callbacks relating to a given Channel (PV name + priority) will never be executed concurrently. +This implies that callbacks for a single operation will also never be executed concurrently. + +User code must avoid doing unnecessary work from within a callback function as this will +prevent other callbacks from be executed. + +Ownership +^^^^^^^^^ + +User provided callbacks are in the form of std::function which may, +directly or indirectly, store ``shared_ptr<>`` instances. +The returned Operation and Subscription instances should be treated as +storing the std::function instance(s) and thus any ``shared_ptr<>`` captured in them. + +Therefore, in order to avoid a resource leak, +it is advisable to consider whether a returned Operation or Subscription +may participate in a reference loop. + +For example, the following creates a reference loop between the Operation instance and the "mystruct" instance. + +.. code-block:: c++ + + struct mystruct { + std::shared_ptr op; // <-- Danger! + }; + auto myptr = std::make_shared(); + + Context ctxt(...); + myptr->op = ctxt.get("pv:name") + .result([myptr](Result&& result) { // <-- Danger! + }) + .exec(); + +While such loops can be explicitly broken (eg. by NULLing 'myptr->op') it is strongly +recommended to avoid such situations as unexpected (exceptional) conditions can easily +lead to resource leaks which are quite difficult to detect and isolate. + +Where possible it is recommended to capture weak_ptr<> instances. + +pvRequest +--------- + +All operations except info() (GET_FIELD) take a Value which servers may use to modify or qualify the operation. +Conventionally, the two ways this may be done is to provide a mask to limit the (sub)fields for which data is returned. +Secondly, to provide certain well-known options to modify the operation. + +The pvRequest conditions may be specified in three ways through the methods of `pvxs::client::detail::CommonBuilder` +exposed through the individual \*Builder types. + +Programmatic + The field() and record() methods. + +Textual + The pvRequest() method accepts a string which is parsed into calls to the field() and record() methods. + These two approaches may be intermixed. + +Fallback + The rawRequest() method accepts an externally assembled Value which is sent without modification. + + +.. doxygenclass:: pvxs::client::detail::CommonBuilder + :members: + +Syntax +^^^^^^ + +The parser behind `pvxs::client::detail::CommonBuilder::pvRequest` understands the following grammar. + +.. productionlist:: + pvRequest : | entry | pvRequest entry + entry : field | record | field_name + field : "field" "(" field_list ")" + record : "record" "[" option_list "]" + field_list : | field_name | field_list "," field_name + option_list : | option | option_list option + option : key "=" value + +For examples: + +* "field()" +* "field(value)" +* "value" +* "field(value,alarm)" +* "field(value)field(alarm)" +* "record[wait=true]" +* "field()record[wait=true]" +* "field(value)record[wait=true]" + +Misc +---- + +.. doxygenstruct:: pvxs::client::Config + :members: + +.. doxygenstruct:: pvxs::client::Connected + :members: + +.. doxygenstruct:: pvxs::client::Disconnect + :members: + +.. doxygenstruct:: pvxs::client::Finished + :members: + +.. doxygenstruct:: pvxs::client::RemoteError + :members: diff --git a/_sources/details.rst.txt b/_sources/details.rst.txt new file mode 100644 index 000000000..510a06738 --- /dev/null +++ b/_sources/details.rst.txt @@ -0,0 +1,209 @@ +******* +Details +******* + +.. _reportbug: + +Reporting a Bug +=============== + +Before reporting a bug, please check to see if this issue has already been `reported `_. + +When composing a new report, please run the included automatic tests "make runtests" and mention the results. +It is enough to mention "All tests successful." if this is so. (see `runtests`) + +`Bug reports `_ should always include: + +* EPICS Base version or VCS commit +* PVXS module version or VCS commit +* libevent version or VCS commit (running "pvxget -V" shows these) +* EPICS host and target archs. (eg. "linux-x86_64") +* Host OS name and version (eg. run "cat /etc/issue") +* Compiler name and version (eg. run "gcc --version") +* The values of any $EPICS_PVA* environment variables which are set. +* Any local/site modifications to PVXS or libevent +* Concise instructions for reproducing the issue. + +Additional information which may be relevant: + +* Number of network interfaces if more than one. +* Whether clients and/or servers are on the same host or different hosts. +* Whether clients and/or servers are in the same subnet or different subnets +* Whether network traffic crosses between virtual machine(s) and physical host(s). +* Firewall rules on UDP traffic to/from port 5075 or TCP connections to port 5074 +* Any local/site modifications to EPICS Base + +If the module has built successfully, then running ``pvxinfo -D`` will +report much of this information. + +Packet Capture +-------------- + +Some kinds of issues can be easily reproduced by the reporter, but not by others. +eg. those related to interoperability, site private applications, or "environmental" conditions. +In these cases it may be necessary to capture the troublesome network traffic to file. +This section provides a quick guide for using `Wireshark `_ to do this. + +An important concern when providing a packet capture taken on a private network is to +avoid unintentionally capturing unrelated, and potentially sensitive, traffic. + +Usage of the ``pva.lua`` extension found in `cashark `_ +provides a quick way to filter out non-PVA traffic. :: + + wireshark -X lua_script:pva.lua + +While Wireshark is running, apply a display filter of ``pva`` to show only PV Access protocol traffic. +From the ``File`` menu, select ``Export Specified Packets``, then choose to export only displayed packets. +Please also check ``Compress with gzip``. + +If it is necessary to select only a specific PVA exchange, use the +`Follow TCP Stream `_ +feature to display/export only packets associated with a single TCP connection. +This will result in a display filter expression like ``tcp.stream eq 1``. +When trying to identify a single connection/stream, it may be helpful to apply a filter like ``pva.pv=="special:pv:name"``. + +If if isn't convenient to run the full Wireshark GUI when capturing, +the ``tshark`` CLI utility may be used to capture raw traffic to file. +Display filters like ``pva.lua`` may not be used during capture, +so it will be necessary to filter again using the GUI on another host to produce a second (cooked) capture file. :: + + tshark -i any -f '!port ssh' -w raw.pcapng + gzip raw.pcapng + # copy raw.pcapng.gz to another host + wireshark -X lua_script:pva.lua raw.pcapng.gz + +If is doubt about whether private information has been successfully excluded, +packet capture files may be sent privately to the author by email instead of uploading to github. +The author's PGP key may be found below. + +Please **compress** all capture files uploaded or sent! + +.. _relpolicy: + +Release Policy +============== + +PVXS Release numbering follows the `Semantic Versioning `_ +scheme of MAJOR.MINOR.PATCH with the following amendments. + +* A change to the MAJOR number indicates that a backwards incompatible change to some part of the public API. + This may not effect every user application. + This policy is intended to provide users with confidence in upgrading when MAJOR does not change. +* The PATCH number will only be incremented if changes to the public API are believed to maintain ABI compatibility. + MINOR will be incremented when a known ABI incompatible change is made. + Library SONAMES take the form MAJOR.MINOR. +* Backwards incompatible changes to semi-public :ref:`expertapi` may appear in a MINOR release. +* At this time only one version number is maintained, which is applied to both + the main libpvxs.so and the auxiliary libpvxsIoc.so. + Statements about API or ABI compatibility apply to both libraries as a group. +* See :ref:`ntcompat` for ``NT*`` type construction helpers. + +.. _pgpkey: + +Each release will be accompanied by a signed tag in the git repository, +which may be verified with the author's GPG key +`5C159E669D69E2D4C4E74E540C8E1C8347330CFB `_ +`(alternate) `_ +. + +.. _expertapi: + +Expert APIs +=========== + +The Expert API are a set of semi-public definitions and methods which are not intended for general use, +and may be subject to incompatible change in a minor release. +Expert API calls are wrapped by "#ifdef PVXS_EXPERT_API_ENABLED" +to prevent unintentional usage. + +If a change is considered, +best effort will be made to involve developers/sites known to make use of Expert API. +Prospective users of the Expert API are encouraged to contact the author. + +Elements of the Expert API may be "promoted" to regular/full API status if warranted. + +.. _contrib: + +Contributing +============ + +The recommended path for including changes is through `Pull Request `_. + +When changing c++ code please do: + +* Indent with 4 spaces. No hard tabs. UNIX style EoL. +* Try to maintain the style of surrounding code. +* Include meaningful code comments where reasonable. +* Add doxygen tags ``@since UNRELEASED`` when documenting additions/changes to public APIs. + +but do not: + +* Add any c++ global constructors or destructors in the pvxs library. (Ok in tools, examples, or tests) + +When committing changes please do: + +* Include a commit message +* Break up changes into multiple commits where reasonable +* Include whitespace only changes as separate commits + +.. _contributors: + +Contributors +------------ + +Who did the [work](https://github.com/epics-base/pvxs/graphs/contributors) to make PVXS what it is. + +.. comment: git log --format=format:%aN|sort -u|while read aa; do echo "* $aa"; done + +* Alexander Wells +* Basil Aljamal +* Bruno Martins +* Érico Nogueira +* George McIntyre +* Henrique Silva +* karlosp +* Klemen Vodopivec +* Michael Davidsaver +* Peter Milne +* Simon Rose +* Thomas Ives + +Those who supported this work. + +* [ALS-U](https://als.lbl.gov/als-u/overview/) project at [Berkeley Lab](https://www.lbl.gov/) +* [Diamond Light Source](https://www.diamond.ac.uk/) +* [European Spallation Source](https://europeanspallationsource.se/) +* [Fermilab](https://fnal.gov/) +* [SLAC National Accelerator Laboratory](https://www6.slac.stanford.edu/) +* [SNS](https://neutrons.ornl.gov/sns) at [Oak Ridge National Lab](https://www.ornl.gov/) + +Implementation Notes +==================== + +Misc. notes on design and Implementation. + +* All Server and client Context instances listening on the same UDP port# within a process + will share a single UDP socket. + +* The UDP local multicast fanout aspect of the PVA protocol is not implemented. + +* Client UDP search retry follows a linear backoff starting from 1 second + and stepping to 30 seconds. cf. bucketInterval and nBuckets in client.cpp. + +* To level UDP search traffic, search retry may delay a PV for an extra + bucket if the difference in the number of PVs in the desired and subsequent + buckets is too large. + +* Client Context::hurryUp() expires the search bucket timer immediately, + saving up to bucketInterval seconds. + +* Each Value refers points to a pair of FieldDesc and FieldStorage in arrays + of the same. Value::operator[] steps around in these arrays. + +* There is a hidden StructTop which holds the FieldStorage array and holds + a shared_ptr to the FieldDesc array to join ownership of the two. + +* TCP connection buffering will read up to tcp_readahead (cf. conn.h) bytes + while waiting for a complete header. After a header is received, + the larger of tcp_readahead or the message body length is buffered. + diff --git a/_sources/example.rst.txt b/_sources/example.rst.txt new file mode 100644 index 000000000..e1db55a87 --- /dev/null +++ b/_sources/example.rst.txt @@ -0,0 +1,35 @@ +Examples +======== + +Example are built, but not installed. +They can be found under example/O.\* + +Latest versions https://github.com/epics-base/pvxs/blob/master/example/ + +Shortest Client Get +------------------- + +.. literalinclude:: ../example/simpleget.cpp + :language: c++ + :name: simpleget.cpp + +Shortest Server +--------------- + +.. literalinclude:: ../example/simplesrv.cpp + :language: c++ + :name: simplesrv.cpp + +Client Demo +----------- + +.. literalinclude:: ../example/client.cpp + :language: c++ + :name: client.cpp + +Mailbox Server +-------------- + +.. literalinclude:: ../example/mailbox.cpp + :language: c++ + :name: mailbox.cpp diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 000000000..213c694ce --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,60 @@ +PVXS client/server for PVA Protocol +=================================== + +This module provides a library (libpvxs.so or pvxs.dll) and a set of +CLI utilities acting as PVAccess protocol client and/or server. + +PVXS is functionally equivalent to the +`pvDataCPP `_ and +`pvAccessCPP `_ modules, +which it hopes to eventually supplant (Ok, the author hopes). + +- VCS: https://github.com/epics-base/pvxs +- Docs: https://epics-base.github.io/pvxs +- `Issues `_ (see :ref:`reportbug`) +- :ref:`contrib` + +Dependencies + +* A C++11 compliant compiler + + * GCC >= 4.8 + * Visual Studio >= 2015 / 12.0' + * clang + +* `EPICS Base `_ >=3.15.1 +* `libevent `_ >=2.0.1 (Optionally bundled) +* (optional) `CMake `_ >=3.1, only needed when building bundled libevent + +See :ref:`building` for details. + +Download +-------- + +Releases are published to https://github.com/epics-base/pvxs/releases. +See :ref:`relpolicy` for details. + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + overview + netconfig + example + building + cli + value + client + server + ioc + util + details + releasenotes + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/_sources/ioc.rst.txt b/_sources/ioc.rst.txt new file mode 100644 index 000000000..aeef288ef --- /dev/null +++ b/_sources/ioc.rst.txt @@ -0,0 +1,185 @@ +IOC Integration +############### + +.. code-block:: c++ + + #include + namespace pvxs { namespace namespace ioc { ... } } + +The separate ``pvxsIoc`` library exists to run a PVXS server as part of an IOC. +See also :ref:`includepvxs`. + +IOC Integration respects the **$PVXS_LOG** as well as the **$EPICS_PVA\*** environment variables. +Changes to this environment variable are possible prior to +calling ``*_registerRecordDeviceDriver(pdbbase)``. + +IOC shell +^^^^^^^^^ + +The ``pvxsIoc`` library adds several IOC shell functions which apply to all PVs +served by the Integrated PVA server. + +.. cpp:function:: void pvxsr(int level) + + PVXS Server Report. Shows information about server configuration (level==0) + or about connected clients (level>0). Indirectly calls `pvxs::server::Source::show`. + +.. cpp:function:: void pvxsl(int level) + + PVXS Server List. Lists attached Sources and PV names. + Indirectly calls `pvxs::server::Source::onList`. + +.. cpp:function:: void pvxsi() + + Print information about module versions, target, and toolchain. + May be requested when reporting a bug. + +Adding custom PVs to Server +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. doxygenfunction:: pvxs::ioc::server + +.. _qsrv2: + +QSRV 2 +###### + +Beginning with PVXS 1.2.0 the functionality of `QSRV `_ +is replicated in the ``pvxsIoc`` library. +As of 1.3.0 this feature preview is considered **beta** level with equivalent functionality. + +It is recommended not to load both ``pvxsIoc.dbd`` and ``qsrv.dbd`` in the same IOC process. +However, if this is done. Users may opt out at runtime by setting +``$PVXS_QSRV_ENABLE=NO`` before ``iocInit()``. :: + + # Default with PVXS >= 1.3.0 + # Needed with PVXS 1.2.x + epicsEnvSet("PVXS_QSRV_ENABLE", "YES") + iocInit() + +Functionality +------------- + +The features of QSRV are divided into three broad categories. + +- Single PV access +- Group PV access +- PVA Links + + +IOC Shell +^^^^^^^^^ + +IOC Shell commands specific to database integration. + +.. cpp:function:: void pvxgl(int level, const char* pattern) + + Group PV information. At detail level 0, lists Group names. + Pattern restricts listing to only matching names. + +.. cpp:function:: void dbLoadGroup(const char *file, const char* macros) + + Load Group definitions from a separate JSON file. + (as opposed to ``info(Q:group, {...})`` in a .db file) + See :ref:`groupjson`. + +Single PV +^^^^^^^^^ + +When QSRV is enabled, access to individual/single PVs in the global process database +is automatic and equivalent to the access provided by the Channel Access server +in the IOC (aka. RSRV). + +So ``caget pv:name`` and ``pvxget pv:name`` should be functionally equivalent. + +Beginning with 1.2.3, long string detection is automatic in some cases. +eg. ``.NAME`` and ``.INP``. +In some situations adding a ``$`` suffix is still necessary when addressing +a ``DBF_STRING`` or ``DBF_*LINK`` field to make it visible as a PVA string. +It will not be necessary for clients to interpret a ``char[]`` as a "long string". :: + + # eg. + pvget some:record.NAME$ + pvget some:record.INP$ + +An ``info(Q:form, "...")`` may be used to set the ``display.form`` PVA meta-data hint +which is used by some OPI clients. :: + + record(longin, "my:bits") { + field(VAL, "0x1234") + info(Q:form, "Hex") # hint to clients to render as hexadecimal + } + +or: :: + + record(waveform, "my:long:string") { + field(FTVL, "CHAR") + field(NELM, "1024") + info(Q:form, "String") # hint to QSRV to expose char[] as string + } + +Currently supported format hints are: + +- Default +- String +- Binary +- Decimal +- Hex +- Exponential +- Engineering + +Group PV +^^^^^^^^ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + qgroup + +Access Security +^^^^^^^^^^^^^^^ + +QSRV will enforce an optional access control policy file (``.acf``) loaded by ``asSetFilename()``. +This policy is applied to Single PVs just as RSRV does for Channel Access. +With Group PVs, restrictions are not defined for the group, but rather for the individual member records. +The same policy applies whether record is accessed individually, or through a group. + +Policy application differs from CA (RSRV) in several ways: + +Client hostname is always the numeric IP address. +``HAG()`` entries must either contained numeric IP addresses, +or that ``asCheckClientIP=1`` flag must be set to translate hostnames into IPs on ACF file load (effects CA server as well). +This prevents clients from trivially forging "hostname". +In additional to client usernames ``UAG()`` definitions may contained items beginning with ``role/`` which are matched against the list of local systems groups of which the client username is a member. +Username to group lookup is done *locally* by QSRV, and depends on IOC host authentication configuration. +Note that this is still based on the client provided username string. :: + + UAG(special) { + someone, "role/op" + } + +The "special" ``UAG()`` will match CA or PVA clients with the username "someone". +It will also match a PVA client if the "special" account exists locally, +and is a member of the "op" group (supported on POSIX targets and Windows). + +PVAccess Links +^^^^^^^^^^^^^^ + +Since PVXS 1.3.0. + +When built against Base >= 7.0.1, support is enabled for PVAccess links +using JSON link support syntax. :: + + record(longin, "tgt") {} + record(longin, "src") { + field(INP, {pva:{pv:"tgt"}}) + } + +.. note: The "dbjlr" and "dbpvar" IOC shell command provide information about PVA links in a running IOC. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + pvalink diff --git a/_sources/netconfig.rst.txt b/_sources/netconfig.rst.txt new file mode 100644 index 000000000..73e3f7720 --- /dev/null +++ b/_sources/netconfig.rst.txt @@ -0,0 +1,113 @@ +.. _netconfig: + +PVA Network Configuration +========================= + +Big Picture +----------- + +A PV Access network protocol operation proceeds in two phases: +PV name resolution, and data transfer. +Name resolution is the process is determining which PVA server claims to provide each PV name. +Once this is known, a TCP connection is open to that server, and the operation(s) are executed. + +The PVA Name resolution process is similar to Channel Access protocol. + +When a name needs to be resolved, a PVA client will begin sending UDP search messages to any addresses +listed in **EPICS_PVA_ADDR_LIST** and also via TCP to any servers listed in **EPICS_PVA_NAME_SERVERS** +which can be reached. + +UDP searches are by default sent to port **5076**, subject to **EPICS_PVA_BROADCAST_PORT** and +port numbers explicitly given in **EPICS_PVA_ADDR_LIST**. + +The addresses in **EPICS_PVA_ADDR_LIST** may include IPv4/6 unicast, multicast, and/or broadcast addresses. +By default (cf. **EPICS_PVA_AUTO_ADDR_LIST**) the address list is automatically populated +with the IPv4 broadcast addresses of all local network interfaces. + +Searches will be repeated periodically in perpetuity until a positive response is received, +or the operation is cancelled. + +In order to reduce the number of broadcast packets, which every PVA host must process, +the time between searches will initially by short, but gradually increase +as time passes without a positive response. +This interval may be reduced when a new PVA server begins sending Beacon messages, +or when `pvxs::client::Context::hurryUp` is called. + +Server beacon destinations are by default configured using the client configuration. +This may be overridden with **EPICS_PVAS_BEACON_ADDR_LIST** and **EPICS_PVAS_AUTO_BEACON_ADDR_LIST**. + +.. _environ: + +Environment variables +--------------------- + +This table lists all of the ``$EPICS_PVA*`` environment variables understood by PVXS. +See Client :ref:`clientconf` and Server :ref:`serverconf` for detailed explanations. + +Many variables come in pairs of ``$EPICS_PVA_*`` and ``$EPICS_PVAS_*``. +A Client will look at only ``$EPICS_PVA_*``. +A server will prefer ``$EPICS_PVAS_*`` if set, +or fallback to use the associated ``$EPICS_PVA_*`` if set. + ++----------------------------------+--------+--------+ +| Variable | Client | Server | ++==================================+========+========+ +| EPICS_PVA_ADDR_LIST | x | x | ++----------------------------------+--------+--------+ +| EPICS_PVAS_BEACON_ADDR_LIST | | x | ++----------------------------------+--------+--------+ +| EPICS_PVA_AUTO_ADDR_LIST | x | x | ++----------------------------------+--------+--------+ +| EPICS_PVAS_AUTO_BEACON_ADDR_LIST | | x | ++----------------------------------+--------+--------+ +| EPICS_PVAS_INTF_ADDR_LIST | | x | ++----------------------------------+--------+--------+ +| EPICS_PVA_SERVER_PORT | x | x | ++----------------------------------+--------+--------+ +| EPICS_PVAS_SERVER_PORT | | x | ++----------------------------------+--------+--------+ +| EPICS_PVA_BROADCAST_PORT | x | x | ++----------------------------------+--------+--------+ +| EPICS_PVAS_BROADCAST_PORT | | x | ++----------------------------------+--------+--------+ +| EPICS_PVAS_IGNORE_ADDR_LIST | | x | ++----------------------------------+--------+--------+ +| EPICS_PVA_CONN_TMO | x | x | ++----------------------------------+--------+--------+ +| EPICS_PVA_NAME_SERVERS | x | | ++----------------------------------+--------+--------+ + + +.. _addrspec: + +Address Spec. +------------- + +Entries in **EPICS_PVA*_ADDR_LIST** variables must be in one of the following forms: + +* ``[:][,TTL#][@ifacename]`` +* ``"[""]"[:][,TTL#][@ifacename]`` + +Examples include: + +``myhost`` + Lookup hostname at startup, use default port number. + Use OS routing table. + +``10.1.1.1:5076`` + Explicit IPv4 address and port number. + Use OS routing table. + +``[2600:1234::42]`` + Explicit IPv6 address with default port. + Use OS routing table. + +``224.0.2.3,255@192.168.1.1`` + IPv4 multicast address, with Time To Live set to 255. + Send via the network interface with address ``192.168.1.1``. + Use default port number. + +``[ff02::42:1],1@br0`` + IPv6 multicast address, with Time To Live set to 1 (roughly equivalent to IPv4 broadcast). + Send via the network interface named ``br0``. + Use default port number. diff --git a/_sources/nt.rst.txt b/_sources/nt.rst.txt new file mode 100644 index 000000000..9cc65a46d --- /dev/null +++ b/_sources/nt.rst.txt @@ -0,0 +1,113 @@ +.. _ntapi: + +Common Type Definitions +======================= + +Library of common type definitions. :: + + #include + namespace pvxs { namespace nt { ... } } + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + ntscalar + +.. note:: + The nt::* factories are relatively expensive. + Call them once, then use `pvxs::Value::cloneEmpty` on the result. + +.. _ntcompat: + +Forward Compatibility +--------------------- + +The `Value` objects returned by the ``NT*`` type builders are considered part of the API +for the purposes of the :ref:`relpolicy`. +Addition of a field is considered a compatible change. +An incompatible change being: + +- Removal of a structure field +- A field type change which restricts allowed assignments. + eg. changing ``int32_t`` -> ``string`` would be compatible, but ``string`` -> ``int32_t`` would not. + +The status of change to a struct ID string are currently undefined with respect to compatibility +as the consequences have not yet been explored in practice. + +.. _time_t: + +time_t +------ + +Commonly used sub-structure to represent a time + +.. doxygenstruct:: pvxs::nt::TimeStamp + :members: + +**"secondsPastEpoch"** + Seconds since POSIX epoch of 1 Jan 1970 UTC. + Note that the EPICS epoch is 631152000 seconds after the POSIX epoch. + (cf. POSIX_TIME_AT_EPICS_EPOCH in epicsTime.h from EPICS Base) + +**"nanoseconds"** + Number of nanoseconds since the start of the second. + +**"timeStamp.userTag"** + Extra site-specific information which may provide context for the seconds/nanoseconds value. + +.. _alarm_t: + +alarm_t +------- + +.. doxygenstruct:: pvxs::nt::Alarm + :members: + +**"severity"** + Enumeration of 0 - No Alarm, 1 - Minor, 2 - Major, 3 - Invalid. + + The meaning of Minor and Major are contextual and may be different for each PV. + An Invalid alarm severity means that the value field should not be taken as + a meaningful representation of eg. the quantity being measured. Typically, + it reflects the most recent valid value. + + A UI client may change the state of a widget displaying a value which is alarming + by eg. changing border color. + +**"status"** + Enumeration providing context to **"severity"** 0 - No Alarm, 1 - Device, 2 - Driver, + 3 - Record, 4 - Database, 5 - Configuration, 6 - Undefined, 7 - Client + +**"message"** + Arbitrary string describing the condition being alarmed. + +NTEnum +------ + +Container for a scalar value selection from a list of strings. + +.. doxygenstruct:: pvxs::nt::NTEnum + :members: + +NTNDArray +--------- + +Container for image data used by areaDetector. + +.. doxygenstruct:: pvxs::nt::NTNDArray + :members: + +NTTable +------- + +Container for tabular data. + +.. doxygenstruct:: pvxs::nt::NTTable + :members: + +NTURI +----- + +.. doxygenclass:: pvxs::nt::NTURI + :members: diff --git a/_sources/ntscalar.rst.txt b/_sources/ntscalar.rst.txt new file mode 100644 index 000000000..5a12e319d --- /dev/null +++ b/_sources/ntscalar.rst.txt @@ -0,0 +1,134 @@ + +.. _ntscalar: + +NTScalar and NTScalarArray +========================== + +The ``epics:nt/NTScalar:1.0`` and related ``epics:nt/NTScalarArray:1.0`` +definitions describe a primary 'value' and supporting meta-data. +In the case of NTScalarArray the value is a 1-d array of primitive type. +In the case of NTScalar the value is a single primitive value. + +Both variants include time and alarm meta-data fields, +and optionally display and control meta-data fields. + +.. code-block:: c++ + + using namespace pvxs; + + // single integer + Value iscalar = nt::NTScalar{TypeCode::Int64}.create(); + + // eg. access "value" field + iscalar["value"] = 42; + +.. code-block:: c++ + + // Functionally equivalent pseudo-C++ + struct NTScalar_Int64 { + int64_t value; + struct alarm_t { + int64_t secondsPastEpoch; + int32_t nanoseconds; + int32_t userTag + } alarm; + struct time_t { + int32_t severity; + int32_t status; + std::string message + } timeStamp; + // if NTScalar::display + struct display_t { + int64_t limitLow, limitHigh; + std::string description, units; + // if NTScalar::form + int32_t precision; + struct enum_t { + int32_t index; + std::vector choices; + } form; + } display; + // if NTScalar::control + struct control_t { + int64_t limitLow, limitHigh; + } control; + // ... + }; + + auto iscalar = new NTScalar_Int64(); // not safe! + iscalar->value = 42; + +Fields +------ + +**"value"** + The primary field. May be any `pvxs::TypeCode` other than ``Struct``, ``Union``, ``StructA``, ``UnionA``, or ``Null``. + +**"timeStamp.secondsPastEpoch"**, +**"timeStamp.nanoseconds"**, +**"timeStamp.userTag"** + + See common :ref:`time_t`. + +**"alarm.severity"**, +**"alarm.status"**, +**"alarm.message"** + + See common :ref:`alarm_t`. + +**"display.description"** + Text providing some context about what this value/PV represents. + +**"display.units"** + Text identifying units of value. eg. "V" or "Hz" + +Meta-data for numeric types. + +**"display.limitLow"** + +**"display.limitHigh"** + Hints for clients which can indicate inclusive range of possible values. eg. a UI gauge widget. + Ignore unless limitLow < limitHigh + +**"control.limitLow"** + +**"control.limitHigh"** + Hints for clients on the inclusive range of values which may reasonably be written to this PV. + Ignore unless limitLow < limitHigh + Not authoritative. + +**"valueAlarm.lowAlarmLimit"** + +**"valueAlarm.highAlarmLimit"** + +**"valueAlarm.lowAlarmSeverity"** + +**"valueAlarm.highAlarmSeverity"** + +**"valueAlarm.lowWarningLimit"** + +**"valueAlarm.highWarningLimit"** + +**"valueAlarm.lowWarningSeverity"** + +**"valueAlarm.highWarningSeverity"** + Hints for clients on the ranges of values which will result in a alarms of the given severities. + Could be used by eg. a UI gauge widget to place markers colored by alarm severity. + Actual alarms are signals with **"alarm.severity"**. + + Two value ranges are defined. The names Alarm vs. Warning do not have a special significance. + + Ignore \*Alarm\* range unless lowAlarmLimit < highAlarmLimit + + Ignore \*Warning\* range unless lowWarningLimit < highWarningLimit + + If a value is within a range [low\*Limit, high\*Limit] inclusive then no alarm is expected. + If a value is < low\*Limit then the alarm severity low\*Severity is expected. + If a value is > high\*Limit then the alarm severity high\*Severity is expected. + + +Builder API +----------- + +.. doxygenstruct:: pvxs::nt::NTScalar + :members: diff --git a/_sources/overview.rst.txt b/_sources/overview.rst.txt new file mode 100644 index 000000000..a4d7786e3 --- /dev/null +++ b/_sources/overview.rst.txt @@ -0,0 +1,366 @@ +Overview +======== + +Basics +------ + +What is EPICS? +^^^^^^^^^^^^^^ + +`Overview `_ + +`epics-controls.org `_ + +`APS EPICS site `_ + +What is PVAccess? +^^^^^^^^^^^^^^^^^ + +PVAccess is network protocol supporting both request/response, +and publish/subscribe operations. + +PVA is closely related to the Channel Access (CA) protocol, +which PVA may work alongside, and is intended to supersede. + +Four protocol operations are supported by PVXS. + +- Get - Fetch the present value of a PV. +- Put - Change the value of a PV. +- Monitor - Subscribe to changes in the value of a PV. +- RPC - A remote method call. + +Get, Put, Monitor, and RPC are to the PVA protocol what GET, PUT, POST are to the HTTP protocol. + + +What is a PV? +^^^^^^^^^^^^^ + +In the EPICS world a Process Variable (PV) refers to the idea of a globally addressed data structure. +An EPICS control system is composed of many PVs. +In the millions for large facilities. +The present value of a PV is modified by a combination of remote operations via CA and/or PVA, +and via local processing (eg. values read from local hardware). + +A common example of a PV is a measurement value, for example +a temperature measured by a particular sensor (eg. ``mylab:temp1``). +Another example would be an electromechanical relay, which may be opened or closed. +(eg. ``mylab:valve2``) + +A PV name is needed when initiating any PVA operation. +eg. with the ``pvx*`` utility executables. :: + + ## fetch current value of both measurement and setting + $ pvxget mylab:temp1 mylab:valve2 + ... + ## setup subscription of both. + $ pvxmonitor mylab:temp1 mylab:valve2 + ... + Ctrl+c + ## Request setting change + $ pvxput mylab:valve2 1 + ... + +In the case of the relay, a Get operation would poll the current open/closed state of the relay. +A Monitor operation (subscription) would setup and receive notification when the relay state changes. +A Put operation would be used to command the relay to open or close, or perhaps toggle (the precise meaning of a Put is context dependent). + +So the Get, Put, and Monitor operation on a given PV are conventionally operating on a common data structure. +The RPC operation is more arbitrary, and need not have any relationship with a common data structure (eg. the open/closed state of the relay.) + +.. note:: In the context of the PVA or CA protocols, a "PV name" is an address string which uniquely identifies a Process Variable. + All PVA network operations begin with a "PV name" string. + +A "PV name" string is to the PVA and CA protocols what a URL is to the HTTP protocol. +The main difference being that while a URL is hierarchical, having a hostname and path string, +a PV name is not. The namespace of PV names is by default all local IP subnets (broadcast domains). +This can be made more complicated though the specifics of client/server network configuration. + +The P4P module provides the ability to run PVA clients (cf. :ref:`clientapi`) and/or servers (cf. :ref:`serverapi`). + +PVXS Module +----------- + +There are three main components of the PVXS module: data container, network client, and network server. + +Structured data is packaged into a `pvxs::Value` container. +In the PVA protocol, excepting the RPC operation, the server side of a network connection will dictate +the specific structure used. + +A user of the client API will interact with Value instances of these server specified structures. +Conversely, a user of the server API will need to decide on which data structures to use. + +Comparison with pvDataCPP +------------------------- + +The data component (`pvxs::Value`) of PVXS corresponds with the `pvDataCPP `_ module. +It also incorporates parts of the `normativeTypesCPP `_ module (cf. `ntapi`). + +The most obvious difference in the design of pvData vs. PVXS is that the "class PVField" hierarchy is replaced +with the single `pvxs::Value` class. +This avoids the need for explicit, often unsafe, downcasting (base to derived) within this hierarchy. + +Further, handling of PVField instances was always by smart pointer, +opening many possibilities to dereference NULL pointers. +By contrast, Value objects handle this indirection internally. +Operations on a empty (aka. NULL) Value are well-defined, +and are made safe by the type system and exceptions. + +Sub-field Lookup +^^^^^^^^^^^^^^^^ + +Consider the following examples with pvDataCPP. +First, as seen in early code. + +.. code-block:: c++ + + PVStructurePtr top = ...; // maybe result of a Get operation (assume !NULL) + PVIntPtr value = top->getSubField("value"); + if(!value) + throw ... + int32_t val = value->get(); + +It is necessary to always remember to check for NULL when looking up sub-fields. +Experience has shown that this is very easy to forget, and the result is a client crash +if eg. the server type changes from PVInt (int32) to PVLong (int64). + +This can be improved by using the getSubFieldT() method which throws instead of returning NULL. +Using PVScalar intermediate base class allows opportunistic conversion between scalar types, +and throws when this is not possible (eg. between array and scalar). + +.. code-block:: c++ + + PVStructurePtr top = ...; + int32_t val = top->getSubFieldT("value")->getAs(); + +With PVXS, the behavior is similar with a more compact syntax. + +.. code-block:: c++ + + Value top = ...; // maybe result of a Get operation (could be NULL) + int32_t val = top["value"].as(); + +Another case to consider is when a client wishes to extract a value from an optional field, +or use a default if the field is not provided. + +.. code-block:: c++ + + PVStructurePtr top = ...; + uint32_t lim = 1234u; // default + if(PVScalarPtr limitHigh = top->getSubField("display.limitHigh")) { + lim = limitHigh->getAs(); // could still throw! + } + +With PVXS + +.. code-block:: c++ + + Value top = ...; + uint32_t lim = 1234u; // default + (void)top["display.limitHigh"].as(lim); // returns true if lim is updated + +Structure Iteration +^^^^^^^^^^^^^^^^^^^ + +Also consider iteration of the fields of a structure (children). + +.. code-block:: c++ + + PVStructurePtr top = ...; + for(PVFieldPtr& fld : top->getPVFields()) { + std::cout<< fld->getFullName() <<" : "<<*fld<<"\n"; + } + +With PVXS + +.. code-block:: c++ + + Value top = ...; + for(Value fld : top.ichildren()) { + std::cout<< top.nameOf(fld) <<" : "<getSubField("value")) { + if(valid->get(value->getFieldOffset()) + || valid->get(top->getFieldOffset())) + { + // "value" exists and is provided + int32_t val = value->getAs(); + } + } + +To unpack this. Provided that sts.isSuccess(), and that neither 'top' nor 'valid' are NULL, +the valid bit mask indicates which fields the server has actually provided a value for. +Others retain a local default (zero or empty). + +In order to find out if the "value" field has actually been provided by the server, +one must obtain the numeric field offset (bit index) with getFieldOffset(), +and then query the BitSet. + +This approach opens the possibility of testing the wrong bit, or more commonly, +not enough bits as it requires explicit knowledge about the PVA concept of "compress" bits +for the top structure and any intermediate sub-structures. + +.. code-block:: c++ + + [](const pvxs::client::Result&& result) + { + try { + Value top = result(); // throws on local or remote error + if(Value value = top["value"].ifMarked()) { + // "value" exists and is provided + int32_t val = value.as(); + } + } catch(std::exception& e) { + std::cout<<"oops : "<getNumberFields())); + + PVScalarPtr value = top->getSubFieldT("value"); + value->putFrom(42); + changed->set(value->getFieldOffset()); + +With PVXS Value, this is automatic. + +.. code-block:: c++ + + Value top = ...; + + top["value"] = 42; + assert(top["value"].isMarked()); + +NTScalar +^^^^^^^^ + +PVXS provides facility for building some common Normative Types, as with the normativeTypesCPP module. + +.. code-block:: c++ + + PVStructurePtr top = NTScalar::createBuilder() + ->value(pvInt) + ->addAlarm() + ->addTimeStamp() + ->addDisplay() + ->createPVStructure(); + +becomes: + +.. code-block:: c++ + + Value top = nt::NTScalar{Int32, true}.create(); + +The options are the value type (Int32) and whether display meta-data is included. +Alarm and time meta-data are always included. + +Custom Structures +^^^^^^^^^^^^^^^^^ + +Defining new structures with pvDataCPP is best accomplished with a FieldBuilder. + +.. code-block:: c++ + + PVStructurePtr top = pvd::getFieldCreate()->createFieldBuilder() + ->add("value", pvInt) + ->addNestedStructure("alarm") + ->add("severity", pvInt) + ->endNested() + ->createStructure() + ->build(); + +becomes: + +.. code-block:: c++ + + using namespace pvxs::members; + Value top = TypeDef(TypeCode::Struct, { + Int32("value"), + Struct("alarm", { + Int32("severity"), + }), + }).create(); + +One significant difference which may not be immediately obvious is that the later +will be automatically indented correctly by code beautifiers. + +Comparison with pvAccessCPP +--------------------------- + +The client and server components of PVXS are heavily influenced by the `pvac `_ and `pvas `_ APIs of pvAccessCPP. +eg. the analog of pvac::ClientProvider is `pvxs::client::Context`, while pvas::Server and pvas::SharedPV correspond with `pvxs::server::Server` and `pvxs::server::SharedPV`. + +The principle practical difference is that PVXS uses functors where the other APIs using interface classes. + +For example, sub-classing pvac::ClientChannel::GetCallback to provide a getDone() callback. + +.. code-block:: c++ + + struct MyGetCallback : public pvac::ClientChannel::GetCallback { + pvac::Operation inprog; + void getDone(const GetEvent& evt) override { + ... + } + }; + ... + void startOp(ClientChannel& chan, ) { + MyGetCallback cb; + cb.inprog = chan.get(&cb); + ... + + +With PVXS, this becomes: + +.. code-block:: c++ + + void startOp(pvxs::client::Context& ctxt) { + std::shared_ptr op = ctxt.get("pv:name") + .result([](pvxs::Result&& result) { + ... + }) + .exec(); + ... + } diff --git a/_sources/pvalink.rst.txt b/_sources/pvalink.rst.txt new file mode 100644 index 000000000..e50b25eea --- /dev/null +++ b/_sources/pvalink.rst.txt @@ -0,0 +1,169 @@ +.. _pvalink: + +PVA Links +######### + +Since 1.3.0 + +JSON Reference +============== + +A PVA link `JSON schema `_ definition file is available. + +Default values for all keys. :: + + record(longin, "tgt") {} + record(longin, "src") { + field(INP, {pva:{ + pv:"tgt", + field:"", + local:false, + Q:4, + pipeline:false, + proc:none, + sevr:false, + time:false, + monorder:0, + retry:false, + always:false, + defer:false + }}) + } + +Certain keys are only relevant with certain link types. + ++----------+-------+--------+---------+ +| Key | Input | Output | Forward | ++==========+=======+========+=========+ +| pv | X | X | X | ++----------+-------+--------+---------+ +| field | X | X | X | ++----------+-------+--------+---------+ +| local | X | X | X | ++----------+-------+--------+---------+ +| proc | | X | X | ++----------+-------+--------+---------+ +| retry | | X | X | ++----------+-------+--------+---------+ +| atomic | X | | | ++----------+-------+--------+---------+ +| defer | X | | | ++----------+-------+--------+---------+ +| monorder | X | | | ++----------+-------+--------+---------+ +| pipeline | X | | | ++----------+-------+--------+---------+ +| Q | X | | | ++----------+-------+--------+---------+ +| sevr | X | | | ++----------+-------+--------+---------+ +| time | X | | | ++----------+-------+--------+---------+ +| always | | | | ++----------+-------+--------+---------+ + +``pv`` names the target PV in full. + +``field`` selects a sub-structure of the target PV. +By default ``""`` the top level structure is used. +If the target field is a Structure, then ``.value`` +and various NTScalar meta-data fields are used. +Otherwise, the the targeted field is used as the value +without any meta-data. + +``local`` set to require that ``pv`` reference a record in the local database. + +``Q`` requests a certain subscription queue depth. + +``pipeline`` selects per-subscription flow control. + +``proc`` may be set to: + +- ``null`` (default). Server selects ``"NPP"`` or ``"PP"`` behavior. +- ``true`` / ``"PP""``. Requests target recorded be "processed" after value update. +- ``false`` / ``"NPP"``. Requests only value update. +- ``"CP"`` Subscribes to target PV. Process this record on each update as well as (dis)connect event. +- ``"CPP"``. Equivalent to ``"CP"`` if ``SCAN=Passive``. Otherwise behaves like ``"NPP"``. + +``sevr`` controls if and how alarm state of target PV is applied to Maximize Severity. + +- ``"NMS"`` (default) Target PV severity is not considered. +- ``"MS"`` All target PV severities are considered. +- ``"MSI"`` Only ``INVALID`` severity is considered. +- ``"MSS"`` Currently equivalent to ``"MSI"``. + +``time`` If ``true`` (not default) and the selected field of the target PV has a ``timeStamp`` sub-structure, +then this time will be written to the record ``TIME`` field. +In almost all cases if will also be necessary to set ``field(TSE, "-2")``. + +``retry``. For an output link, and ``true`` (not default), then the most recent incomplete PUT +will be re-tried when the target PV (re)connects. + +``always``. Ignored. ``false`` (default). + +``atomic``. When ``true`` (not default) then ``"CP"`` and ``"CPP"`` link processing will +be done all related records locked (cf. ``dbLockMany()``). +If several records with ``atomic:true`` are linked to different structure fields of the same target this PV, +then all records will be locked together and all resulting processing will be atomic. + +``monorder`` the relative ordering (increasing) of processing of ``"CP"`` and ``"CPP"`` records linked to the same target PV. + +``defer``. If ``true`` (not default) this output link will only cache the value to be PUT, +but will not issue a network operation. +Can be used to update several structure fields in a single network PUT. + +Input Links +=========== + +Creating a ``pva`` link will result in a subscription being made to the target PV. +Updates will be accumulated in a local cache. +Link processing reads the most recent value/alarm/time from this cache. +While disconnected, a link will read the most recent value/time, with an ``INVALID`` alarm severity. :: + + record(longout, "src") { + field(INP, {pva:{pv:"target:pv"}}) + } + +To trigger record processing when a monitor update arrives, +add the ``proc:"CP"`` modifier. :: + + record(longout, "src") { + field(INP, {pva:{ + pv:"target:pv", + proc:"CP" + }}) + } + +Output Links +============ + +The default behavior of a ``pva`` output link is to write the link value into a local cache, +and then immediately flush that cache and into a network PUT operation. +``defer:true`` allows prevents a link from immediately flushing, +which allows changes to multiple fields to be combined into a single PUT (eg. writing to :ref:`grouppv`). + +By default, an output link will write the ``.value`` structure field of the target PV. +Any processing is at the discretion of the server. +(hint, look for ``pp(TRUE)`` or ``pp(FALSE)`` in ``*Record.dbd``) :: + + record(longout, "src") { + field(OUT, {pva:"target:pv"}) + } + +or equivalently: :: + + record(longout, "src") { + field(OUT, {pva:{ + "pv":"target:pv" + }}) + } + +Additionally, as with DB links, a link may request control of target processing +by setting the ``proc:`` key with ``true`` / ``"PP""``, or the opposite with +``false`` / ``"NPP"``. + +Forward Links +============= + +A ``pva`` forward link will send an empty PUT request (no field changes) to the target PV with ``proc:true``. +If the target PV is a record, then this is equivalent to a PUT of ``.PROC``. diff --git a/_sources/qgroup.rst.txt b/_sources/qgroup.rst.txt new file mode 100644 index 000000000..8f95f4916 --- /dev/null +++ b/_sources/qgroup.rst.txt @@ -0,0 +1,257 @@ +.. _grouppv: + +QSRV Groups +########### + +By default no Group PVs are defined. + +A Group PV is a mapping of values stored in one or more database records +and made visible through a PVA structure. + +A Group is defined using a JSON syntax. +Groups are defined with respect to a *Group Name*, which is also the PV name used when accessing the group. +Unlike records, the "field" of a group have a different meaning than the fields of a record. +Group field names are *not* part of the PV name. + +A group definition may be split among several records, or included in separate JSON file(s). +For example of a group including two records is: :: + + record(ai, "rec:X") { + info(Q:group, { + "grp:name": { + "X": {+channel:"VAL"} + } + }) + } + record(ai, "rec:Y") { + info(Q:group, { + "grp:name": { + "Y": {+channel:"VAL"} # .VAL in enclosing record() + } + }) + } + +Or equivalently with separate .db file and .json files. +Use ``dbLoadGroup()`` to load .json files. :: + + # Store in some .db + record(ai, "rec:X") {} + record(ai, "rec:Y") {} + # Store in some .json + { + "grp:name": { + "X": {+channel:"rec:X.VAL"}, # full PV name + "Y": {+channel:"rec:Y.VAL"} + } + } + +This group, named ``grp:name``, has two group fields ``X`` and ``Y``. :: + + $ pvget grp:name + grp:name + structure + epics:nt/NTScalar:1.0 X + double value 0 + alarm_t alarm INVALID DRIVER UDF + time_t timeStamp 0 + ... + epics:nt/NTScalar:1.0 Y + double value 0 + alarm_t alarm INVALID DRIVER UDF + time_t timeStamp 0 + ... + +So ``pvget grp:name`` is compatible to ``pvget rec:X rec:Y`` with the added +benefit that with the former, values from the two records are read atomically on the server, +and delivered together. + +.. _groupjson: + +JSON Reference +============== + +A Group `JSON schema `_ definition file is available. +Keys beginning appear in contexts where a name may be either a data field name, +or a special key. + +.. code-block:: + + record(...) { + info(Q:group, { + "":{ + +id:"some/NT:1.0", # top level ID + +atomic:true, + "":{ + +type:"scalar", + +channel:"VAL", + +id:"another/NT:1.0", + +trigger:"*", + +putorder:0, + }, + # special case adds time/alarm meta-data fields + # at top level + "": {+type:"meta", +channel:"VAL"} + } + }) + } + +Mapping ``+type``: + +- ``scalar`` (default) places an NTScalar or NTScalarArray as a sub-structure. (see :ref:`ntscalar`) +- ``plain`` ignores all meta-data and places only the "value" as a field. + The field placed will have the type of the ``value`` field of the equivalent NTScalar/NTScalarArray as a field. +- ``any`` places a variant union into which the "value" is stored. +- ``meta`` places only the "alarm" and "timeStamp" fields of ``scalar``. +- ``structure`` places only the associated ``+id``. Has no ``+channel``. +- ``proc`` places no fields. The associated ``+channel`` is processed on PUT. + "proc" mappings will almost always set ``+putorder`` to control the relative + ordering of record processing. + + +Mapping ``+channel``: + +Most mapping ``+type`` require a ``+channel``. +The most common record field to map is ``+channel: "VAL"``. +When included in an ``info(Q:group, ...``, the ``+channel`` must only name a field of the enclosing record. +(eg. ``+channel:"VAL"``) +When in a separate JSON file, ``+channel`` must be a full PV name, beginning with a record or alias name. +(eg. ``+channel:"record:name.VAL"``) + +Mapping ``+trigger``: + +Triggers define when and which **changes to the constituent field are translated into a subscription update** to the group. +``+trigger`` may be set to: + +- ``""`` (default) means that changes to the field do not cause a subscription update. (see note below) +- ``"*"`` causes a subscription update containing the most recent values/meta-data of all group fields. +- A comma separated list of field names causes an update with the most recent values of only the listed group fields. + eg. ``+trigger: "value.A, value.B"``. + +For a new group definition, including records from one or more record processing chains, +the last record in that chain should have a ``+trigger`` mapping listing the group fields +updated by records in that chain. + +In the common case where a group is mapped to records in only one processing chain, +then the last mapped record in that chain should have ``+trigger: "*"``. + +.. note:: As a special case. A group with no ``+trigger`` mappings at all will function as if every mapping + includes a ``+trigger`` mapping for itself. + This is done so that such a situation does not cause confusion be posting no monitor updates at all. + However, this situation will almost never give desired behaviour as changes to records which + could otherwise be atomic will be split into multiple subscription updates. + +Mapping ``+putorder``: + +``+putorder`` must be set for a field to be writable through a group PV. +When more than one mapping has an order defined, the numeric value is used to define +the order in which the associated records are processed (in increasing order). + +Additionally, the values of ``+putorder`` also control the order of fields in the group PV definition. +This control is necessary only in limited cases, such as the ``NTTable`` specification, +where the iteration order of fields must match the order of the ``labels`` array. + +.. _understandinggroups: + +Understanding Groups +==================== + +NTTable Group Example +--------------------- + +One motivating use case for groups involves moving tabular data, encoded as "NTTable". +The overall goal of the ``TST:Tbl`` group PV is to take what would be a series of +discrete, non-atomic, network operations :: + + caput -a TST:A X 1 2 3 + caput -a TST:B X 5 6 7 + caput TST:Save.PROC 1 + +can instead be a single, atomic, network operation :: + + pvput TST:Tbl value.A='[1,2,3]' value.B='[5,6,7]' + +A subscriber sees: :: + + pvmonitor TST:Tbl + TST:Tbl INVALID DRIVER UDF + "Label A" "Label B" + TST:Tbl 2023-08-30 09:55:19.999 + "Label A" "Label B" + 1 5 + 2 6 + 3 7 + +This effect is achieved by mapping a table of two columns ("A" and "B") onto two ``aao`` records. +With a third record to take some action once both are updated. + +The following is meant to illustrate the mapping between the individual records, +and the fields of the group PV ``TST:Tbl``. + +On the left hand side are the contents of a file ``test.db``, +and on the right the output of ``pvget TST:Tbl``. + +.. raw:: html + +
+ +.. image:: _image/nt_table1.svg + +Here the ``TST:Labels_`` record contributes two mappings to the ``TST:Tbl`` Group. +(a record might contribute mappings to more than one group) + +This ``+id`` mapping contributes only the static type label string. +it could be attached to any of the four records, and is arbitrarily placed with this one. + +Necessarily, the ``label`` mappings provides the column labels of the "NTTable" definition. +So the record ``TST:Labels_`` field ``VAL`` is mapped into ``TST:Tbl`` as ``labels``. +With ``+type: "plain"``, this appears as a string array ("string[]"). + +.. raw:: html + +
+ +.. image:: _image/nt_table2.svg + +The ``TST:A`` record contributes only a ``value.A`` field. +With ``+type: "plain"``, this appears as a string array ("double[]"). + +The ``value.A`` mapping also sets ``+putorder: 0``, which is necessary to allow this group member +field to be changed through a PUT to the Group PV. +The numeric value controls the order in which records effected by a PUT are processed. +Processing occurs in order of increasing ``+putorder``. + +.. raw:: html + +
+ +.. image:: _image/nt_table3.svg + +The ``TST:B`` record contributes both a ``value.B`` field in the same manner as the A field/column. + +Additionally, it contributes a special ``""`` field with ``+type: "meta"``. +This exposes the ``TST:B.VAL`` timestamp and alarm meta-data as the sub-structure +fields ``alarm`` and ``timeStamp``. + +.. raw:: html + +
+ +.. image:: _image/nt_table4.svg + +The final record ``TST:Save`` does not contribute any data fields. +Instead it contributes a special ``+type: "proc"`` mapping. +Also, it contributes a ``+trigger`` mapping so that processing this record will +trigger a subscription/monitor update to all (changed) fields. + +Note, the field name ``_save`` only needs to be locally unique within the group, +but is otherwise ignored. + +Database Listing +^^^^^^^^^^^^^^^^ + +Loading the following with. :: + + dbLoadRecords("table.db", "N=TST:,LBL1=Label A,LBL2=Label B,PO1=0,PO2=1") + +.. literalinclude:: ../test/table.db + :linenos: diff --git a/_sources/releasenotes.rst.txt b/_sources/releasenotes.rst.txt new file mode 100644 index 000000000..a87282a78 --- /dev/null +++ b/_sources/releasenotes.rst.txt @@ -0,0 +1,318 @@ +.. _releasenotes: + +Release Notes +============= + +1.3.2 (UNRELEASED) +------------------ + +* client: Avoid FD leak on failed connect() +* Correctly set TCP_NODELAY on winsock +* ioc: Workaround asTrapWrite clobbering dbChannel +* ioc: ACF fix write permit when groups are present + +1.3.1 (Dec 2023) +---------------- + +* Install pvxsIoc.dbd with the correct name in python build. +* No change to Makefile build. + +1.3.0 (Dec 2023) +---------------- + +* Set TCP_NODELAY on client and server sockets. +* Disambiguate Size from Selector when decoding messages. +* QSRV + * :ref:`qsrv2` now considered "feature complete". + * Avoid sending 0 precision w/ integer value. + * Add :ref:`pvalink`. + +1.2.4 (Oct 2023) +---------------- + +* data: Relax when assigning struct[] or union[] of similar types. +* client: avoid assert() with invalid forced server name. +* client: propagate exception during early op. setup. +* client: GET yield complete updates after first. +* server: Ensure that variables bound into operation callback ``std::function<>`` are + released promptly when that operation is ended. +* server: relax post() after finish(). Return false instead of throwing ``std::logic_error``. +* ioc: ensure db_cancel_event() before ~MonitorControlOp + * Workaround for [db_cancel_event()](https://github.com/epics-base/epics-base/issues/423) bug. +* ioc: Fix typo preventing processing of DBR_STRING fields. +* ioc: fix group put always `dbProcess()`. +* ioc: fix block=true to DBF_ENUM. +* ioc: actually require +putorder to PUT. +* ioc: group put w/o effect is an error. +* ioc: accept record._options.process as bool +* ioc: group avoid post() empty events + +1.2.3 (Sept 2023) +----------------- + +* Add ``$PVXS_ENABLE_IPV6`` environment variable. Set ``PVXS_ENABLE_IPV6=NO`` to disable usage of IPv6. +* IOC: A warning is printed if a group definition includes no ``+trigger`` mappings. + This is likely a mis-configuration by omission which will produce more monitor updates than expected. +* `pvxs::server::ConnectOp::error` no longer blocks. +* Add `pvxs::target_information`. +* IOC: fill in ``display.precision``. +* Add :ref:`understandinggroups` section. +* Add `pvxs::nt::NTTable` helper. +* Clarify some exception messages. +* Add `pvxs::ioc::testPrepare`. + +1.2.2 (June 2023) +----------------- + +* IOC: improve long string detection. +* Changes to Tree output format for ``Value``. +* Applied various bug fixes for issued detected by static analysis. All believed to be minor. + +1.2.1 (June 2023) +----------------- + +* Quiet erroneous MONITOR exceeds window size warning message on ``finish()``. +* Fix incomplete py build +* Add Python 3.11 builds (Alex Wells) + +1.2.0 (May 2023) +---------------- + +* server: fix default monitor queueSize to 4 +* improve localhost multicast forwarding +* server: bind both wildcard for UDP +* update bundled libevent +* Add `pvxs::nt::NTScalar::form`. +* NTEnum add ``display.description`` +* client: schedule initial search use separate event from the generic work queue. (Thomas Ives) +* client: re-define the meaning of poke() +* server: fix ``stats(reset=true)`` +* prevent simple ``Any`` self-assignment +* ``Value::copyIn()`` (also ``from()`` and ``operator =``) add ``Array`` -> ``Array`` w/ implied alloc+convert +* client: fix batch pop() of exception +* fix monitor pipeline and ``finish()`` +* server: add MonitorStat::nSquash +* Add *feature preview* of :ref:`qsrv2` IOC server functionality. + +1.1.4 (April 2023) +------------------ + +* client: fix delta sync of Compound. Regression in 1.1.0. +* Add wrappers for some libevent socket manipulations as :ref:`expertapi`. +* Improve diff output of `testStrEq`. +* msvc build compat. ``/wd*`` compiler flags sometimes interpreted as paths. + +1.1.3 (Mar 2023) +---------------- + +* Fix `pvxs::Value::nmembers` which erroneously returned ``0`` for ``StructA`` and ``UnionA``. +* Fix `pvxs::Value::unmark` where ``parent=true`` caused corruption. +* Change to "magic" automatic ``Union`` member selection during assignment. +* Fix `pvxs::shared_array::convertTo` converting ``Float64`` to ``Float32`` caused corruption. +* Fix TypeDef(const Value& val) for Union/UnionA/StructA +* Fix unsigned handling +* server: rework cleanup of connection, channel, and operation + +1.1.2 (Feb 2023) +---------------- + +* SigInt fix disarm +* Value fix delta output format to actually show delta. +* add `pvxs::shared_array::thaw()` +* `pvxs::Value::lookup()` throw NoField +* Require ``setuptools_dso>=2.7a1``. + +1.1.1 (Dec 2022) +---------------- + +* Fix protocol decoding error with TypeStore. + +1.1.0 (Nov 2022) +---------------- + +* Client Subscription yields "complete" Value to user code. + Unchanged fields will appear with the values most recently received, + kept in an internal cache. As a consequence, array and union fields + will always be shared with this case, and can never be safety modified. +* Change Server monitor watermark meaning from edge to level trigger. +* `pvxs::SigInt` executes callback on worker thread instead of signal context. +* Added API + + * `pvxs::client::Subscription::stats` and `pvxs::server::MonitorControlOp::stats` + * `pvxs::client::Context::close()` + * `pvxs::TypeDef::as()` overload to change Struct -> StructA. + * `pvxs::Value::clear()` + +1.0.1 (Oct 2022) +---------------- + +* Fix c++17 compilation issue +* Allow TypeDef to append StructA and UnionA +* Reduce "non-existent IOID" noise +* Fix CMD_MESSAGE handling +* Fix locking of client monitor during pop() +* Calculate buffer sizes in terms of OS socket buffer limit +* Fix low water mark calculation +* Fix Timer ownership (expert API) +* Avoid ``assert()`` when client asked to search for PV names longer than 1400 bytes. + +1.0.0 (Sept 2022) +----------------- + +* Add `pvxs::client::ConnectBuilder::server` +* Add hold-off timer when reconnecting to a specific server. +* Fix missing closing quote when printing a ``String`` in tree format. + +0.3.1 (June 2022) +----------------- + +* Fix ifaddrs::ifa_addr can be NULL +* Limit beacon tracking by size as well as time + +0.3.0 (May 2022) +---------------- + +* Fix protocol **incompatibility** with Big Endian servers. +* Add support for IPv4 multicast and IPv6 uni/multicast for UDP. And IPv6 unicast for TCP. + See :ref:`addrspec` for entries which may now appear in **EPICS_PVA*_ADDR_LIST**. +* PVXS now attempts to fanout unicast searches through the loopback interface, and + to handle ``CMD_ORIGIN_TAG`` messages (aka. the local multicast hack). +* Add `pvxs::client::Context::discover` to enumerate and track PVA Servers. +* ``pvxlist`` add "continuous" mode. (eg. ``pvxlist -v -w 0``) + To immediately Discover new servers, then continue listening for Beacons to detect + as server go up and down (like ``casw``). + Also, to be gentler on your network, add ``-P`` to skip initial Discovery ping, + and only listen for Beacons. + +0.2.2 (Jan 2022) +---------------- + +* No functional change to libraries. +* Updates to python packaging. + +0.2.1 (Oct 2021) +---------------- + +* Bug fixes + + * Fix `pvxsmonitor` hang when interrupted (Ctrl+c). + * Fix `pvxs::client::Subscription::shared_from_this()` leaking internal reference. + * Fix SharedPV potential race conditions involving "current" Value. + +* Changes + + * Ignore beacons with protocol field other than "tcp". Forward compatibility. + * Limit packet hex dumps to 64 bytes. + * ``testStrMatch()`` now specified POSIX regular expression syntax. + * Client operations builders ``rawRequest(Value())`` is now a no-op. + Previously produced a non-nonsensical empty request. + +* Additions + + * Add `pvxs::client::Context::fromEnv()`. + +0.2.0 (July 2021) +----------------- + +* Bug fixes + + * Resolve ambiguity between Value::as(T&) and Value::as(FN&&) causing issue with GCC 4.8. + * Fix encoding of (Sub)Struct w/ valid set. + * Fix locking issue with client tracking of server beacons. + * Fix binding to specific interface addresses. + +* Changes + + * To simplify usage in situations with complex threading, many client methods avoid unnecessary + synchronization with the client worker thread. + Cancellation still synchronizes by default, but this may now be controlled with + the new syncCancel() Builder methods. cf. `pvxs::client::detail::CommonBuilder::syncCancel()`. + * Client Op Builder server() method now implemented. + * Client channel cache now periodically prunes unused Channels automatically. + +* Additions + + * Add server ignore address list. cf. `pvxs::server::Config::ignoreAddrs`. Configured from $EPICS_PVAS_IGNORE_ADDR_LIST. + * Allow TCP timeout to be configured. + * Add `pvxs::client::Context::connect()` to force Channel creation and retention. + * Add `pvxs::client::Subscription::shared_from_this()` which can be used with eg. the new `pvxs::MPMCFIFO` to create a work queue. + * Add `pvxs::server::ExecOp::pvRequest()` + * Semi-public :ref:`expertapi`. + * Update bundled libevent + * Preliminary support for RTEMS 5.1 with libbsd + +0.1.5 (May 2021) +---------------- + +* Bug Fixes + + * Fix several previously unusable template methods of `pvxs::shared_array` + * Fix `pvxs::logger_level_set` + +* Changes + + * Default logger level changed from Err to Warn. + * Server warns when falling back from requested TCP port. + * Public headers include instead of . + +* Additions + + * Add `pvxs::nt::NTEnum` + +0.1.4 (APR 2021) +---------------- + +* Bug Fixes + + * Fix potential locking issue monitor queue + * Fix potential locking issue in Shared PV with concurrent open()/close() vs. post() + +* Additions + + * Add `pvxs::nt::TimeStamp` and `pvxs::nt::Alarm`. + +0.1.3 (FEB 2021) +---------------- + +* Bug Fixes + + * Fix regression from 0.1.2 causing possible crash on targets defining SO_RXQ_OVFL (eg. Linux). + +0.1.2 (FEB 2021) +---------------- + +* Bug Fixes + + * Fix TCP connection "stall" (incorrect deferred read). + +* Changes + + * Raise UDP search reply processing limit. + * Try not to fragment UDP search packets. + * mailbox example can serve more than one PV. + * Indent printed field=value in delta output mode. + +0.1.1 (Jan 2021) +---------------- + +* Bug Fixes + + * Fix decoding of "null" string. Addresses interoperability with pvAccessJava. + * Increase inactivity timeout for TCP connections from 30 to 40 seconds. Also for interoperability with pvAccessJava. + * Client search requests incorrectly set Server direction bit. (existing servers don't enforce this) + * Improved handling of errors resulting from pvRequest processing. eg. field selection which doesn't select any fields. + +* Added Features + + * Added `PVXS_ABI_VERSION` et al. to *pvxs/version.h* + * Add `testThrowsMatch` and `testStrMatch` to *pvxs/unitttest.h* + +* Changes + + * Changed name of automatic Sources ``"builtin"`` and ``"server"`` to ``"__builtin"`` and ``"__server"``. + Document that Source names beginning with `__` are reserved. + +0.1.0 (Dec 2020) +---------------- + + * Initial Release diff --git a/_sources/server.rst.txt b/_sources/server.rst.txt new file mode 100644 index 000000000..0d890355a --- /dev/null +++ b/_sources/server.rst.txt @@ -0,0 +1,93 @@ +.. _serverapi: + +Server API +========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + sharedpv + source + +`pvxs::server::Server` represents a PVA protocol server. + +.. code-block:: c++ + + #include + namespace pvxs { namespace server { ... } } + +The basic recipe to run a server using configuration from the process environment is: + +.. code-block:: c++ + + auto serv = server::Config::fromEnv() + .build() + // calls to serv.addPV() or serv.addSource() + serv.run(); // run intil SIGINT or serv.interrupt() + // could also call serv.start() and later serv.stop() + +A useful server will have one or more `pvxs::server::Source` instances added to it with addSource() method. +Common usage will be with `pvxs::server::StaticSource` and one or more `pvxs::server::SharedPV`. + +If more than one Source is added, then an order of precedence is established through +the "order" argument of addSource(). In the event that more than one Source could +provide/claim a given PV name, the Source with the lowest "order" will win. + +.. _serverconf: + +Configuration +------------- + +The recommended starting point when configuring a Server is `pvxs::server::Config::fromEnv` +which will use the following :ref:`environ` when set. + +Entries naming multiple :ref:`environ` will prefer the left most which is set. +eg. ``EPICS_PVA_ADDR_LIST`` is only checked if ``EPICS_PVAS_BEACON_ADDR_LIST`` is unset. + +EPICS_PVAS_INTF_ADDR_LIST + Space separated list of local interface addresses to which the server will bind. + Port numbers are parsed and ignore. + Sets `pvxs::server::Config::interfaces` + +EPICS_PVAS_BEACON_ADDR_LIST or EPICS_PVA_ADDR_LIST + Space separated list of unicast or broadcast addresses. + This list is supplimented all local broadcast addresses if auto-beacon is YES. + Sets `pvxs::server::Config::beaconDestinations` + +EPICS_PVAS_AUTO_BEACON_ADDR_LIST or EPICS_PVA_AUTO_ADDR_LIST + YES or NO. + Sets `pvxs::server::Config::auto_beacon` + +EPICS_PVAS_SERVER_PORT or EPICS_PVA_SERVER_PORT + Single integer. + Preferred TCP port to bind. + If already in use then a random port will be chosen. + Sets `pvxs::server::Config::tcp_port` + +EPICS_PVAS_BROADCAST_PORT or EPICS_PVA_BROADCAST_PORT + Single integer. + UDP port to bind. + If already in use, then an exception is thrown. + Sets `pvxs::server::Config::udp_port` + +EPICS_PVAS_IGNORE_ADDR_LIST + Space separated list of addresses with optional port. + Port zero is treated as a wildcard to match any port. + UDP traffic from matched addresses will be ignored with no further processing. + +EPICS_PVA_CONN_TMO + Inactivity timeout for TCP connections. For compatibility with pvAccessCPP + a multiplier of 4/3 is applied. So a value of 30 results in a 40 second timeout. + +.. versionadded:: 0.3.0 + All ***_ADDR_LIST** may contain IPv4 multicast, and IPv6 uni/multicast addresses. + +.. versionadded:: 0.2.0 + Prior to 0.2.0 ``EPICS_PVA_CONN_TMO`` was ignored. + +.. doxygenstruct:: pvxs::server::Config + :members: + +.. doxygenclass:: pvxs::server::Server + :members: diff --git a/_sources/sharedpv.rst.txt b/_sources/sharedpv.rst.txt new file mode 100644 index 000000000..dc6ff2d09 --- /dev/null +++ b/_sources/sharedpv.rst.txt @@ -0,0 +1,79 @@ +SharedPV and StaticSource +========================= + +A SharedPV is a single data value which may be accessed by multiple clients through a Server. +It is "shared" in the sense that all clients are manipulating a single variable. + +.. code-block:: c++ + + #include + namespace pvxs { namespace server { ... } } + +Each SharedPV instance has (after open() ) an associated data structure +which is later manipulated with post(). + +A simple usage is: + +.. code-block:: c++ + + using namespace pvxs; + + auto initial = nt::NTScalar{TypeCode::Float64}.create(); + initial["value"] = 42.0; + + auto src(server::StaticSource::build()); + + auto pv(server::SharedPV::buildMailbox()); + pv.open(initial); + + src.add(argv[1], pv); + + auto serv = server::Server::Config::fromEnv() + .build() + .addSource("box", src.source()); + + serv.run(); + +In this context "mailbox" refers to the default onPut() handler, which simply post()s whatever +the client sends. + +An example of a SharedPV with a custom Put handler + +.. code-block:: c++ + + auto pv(server::SharedPV::buildMailbox()); + + pv.opPut([](server::SharedPV& pv, + std::unique_ptr&& op, + Value&& top) + { + // We decide that .value will be present with .open() + auto val = top["value"]; + // is client trying to change .value ? + if(val.isMarked(true, true)) { + auto val = top["value"].as(); + + // clip to range [0, 10] + top["value"] = std::max(0.0, std::min(val, 10.0)); + } + + // update and send to subscribers + pv.post(std::move(top)); + // notify client of success (or call op->error() if not) + op->reply(); + }); + + auto initial = nt::NTScalar{TypeCode::Float64}.create(); + initial["value"] = 42.0; + + auto src(server::StaticSource::build()); + + pv.open(initial); + +.. note:: SharedPV follows the Source rules for :ref:`sourcethreading` and locking. + +.. doxygenstruct:: pvxs::server::SharedPV + :members: + +.. doxygenstruct:: pvxs::server::StaticSource + :members: diff --git a/_sources/source.rst.txt b/_sources/source.rst.txt new file mode 100644 index 000000000..77e87374d --- /dev/null +++ b/_sources/source.rst.txt @@ -0,0 +1,69 @@ +Data Source +=========== + +The low-level API through which a `pvxs::server::Server` may issue requests on behalf of remote clients. :: + + #include + namespace pvxs { namespace server { ... } } + +The `pvxs::server::SharedPV` API should be preferred when a Server has a predetermined set of PV names. + +The `pvxs::server::Source` interface is a more general, and complex, means of allowing a Server +to respond to PV names as clients search for them. +This may be necessary in specialized cases such as gateway, proxy, or bridge servers. + +.. _sourcethreading: + +Threading +--------- + +A Server will invoke user callback functions from one or more internal worker threads. +However, it is guaranteed that callbacks relating to a given PV will never be executed concurrently. +This implies that callbacks for a single operation, +those stored through a `pvxs::server::ChannelControl` and related \*Op, +will also never be executed concurrently. + +Ownership and Lifetime +---------------------- + +The \*Op classes are interfaces through which callback functors are passed. +These functors are stored in underlying, and otherwise hidden, server data structures. +Therefore, it is safe to eg. capture a ``shared_ptr`` into an ``onCancel`` +functor without creating a reference loop. + +The lifetime of these server data structures are tied to the remote client. +So variables captured into a functor like `pvxs::server::ConnectOp::onGet`, or onCancel, +will be destroyed when the client times out, closes the channel, or closes the operation. +Also when the server side forces channel closure via `pvxs::server::ConnectOp::close`. +The various \*Close callbacks may also be used if explicit cleanup is needed on +certain conditions. + +API +--- + +.. doxygenstruct:: pvxs::server::Source + :members: + +.. doxygenstruct:: pvxs::server::OpBase + :members: + +.. doxygenstruct:: pvxs::server::ExecOp + :members: + +.. doxygenstruct:: pvxs::server::ConnectOp + :members: + +.. doxygenstruct:: pvxs::server::MonitorControlOp + :members: + +.. doxygenstruct:: pvxs::server::MonitorSetupOp + :members: + +.. doxygenstruct:: pvxs::server::ChannelControl + :members: + +.. doxygenstruct:: pvxs::server::MonitorStat + :members: + +.. doxygenstruct:: pvxs::server::ClientCredentials + :members: diff --git a/_sources/typedef.rst.txt b/_sources/typedef.rst.txt new file mode 100644 index 000000000..d54a41035 --- /dev/null +++ b/_sources/typedef.rst.txt @@ -0,0 +1,78 @@ +.. _typedefapi: + +Defining Custom Types +===================== + +Interface through which type definitions are created and extended for use with `pvxs::Value`. :: + + #include + namespace pvxs { ... } + +The type system of the PVA protocol consists of a number of primitive and compound types, +as well as arrays of either. +The `pvxs::TypeCode::code_t` enum is an exhaustive list of all valid types, +as well as Null. + +Any valid type may be instantiate directly. + +.. code-block:: c++ + + Value v = TypeDef{TypeCode::String}.create(); + v = "works, but not very interesting"; + +In almost all cases, custom type definitions will be for Structures. +When defining structures, the functions of the `pvxs::members` namespace can help to keep definitions concise. + +.. code-block:: c++ + + namespace M = pvxs::members; + + Value v = TypeDef(TypeCode::Struct, { + M::Int32("ifield"), + M::Float64("fval"), + M::Struct("substruct", { + M::String("desc"), + }), + }).create(); + +It is also possible to extend definitions. + +.. code-block:: c++ + + namespace M = pvxs::members; + + TypeDef def(TypeCode::Struct, { + M::Int32("ifield"), + M::Struct("substruct", { + M::String("desc"), + }), + }); + + def += {M::Float64("fval")}; + Value v(def.create()); + +This also applies to the `ntapi` allowing fields to be added. +eg. adding a string field "display.notes". + +.. code-block:: c++ + + namespace M = pvxs::members; + + TypeDef def = nt::NTScalar{TypeCode::UInt32, true}.build(); + + def += {M::Struct("display", {M::String("notes")})}; + Value v(def.create()); + +.. doxygenstruct:: pvxs::TypeCode + :members: + +.. doxygenclass:: pvxs::TypeDef + :members: + +.. doxygenstruct:: pvxs::Member + :members: + +.. doxygennamespace:: pvxs::members + :members: + +.. doxygenenum:: pvxs::Kind diff --git a/_sources/util.rst.txt b/_sources/util.rst.txt new file mode 100644 index 000000000..f6c70e6dd --- /dev/null +++ b/_sources/util.rst.txt @@ -0,0 +1,171 @@ +Misc +==== + +Logging +------- + +PVXS internally logs warning/status messages using errlog.h from EPICS Base. +User applications may control which messages are printed, and may add output. :: + + #include + namespace pvxs { ... } + +Control of log message output is available through named loggers. +All internal logger names begin with the prefix "pvxs.". + +In addition to a name, each logger has an associated integer logging level. +A message will be logged if the level of the message is less than or +equal to the level of the associated logger. + +To enable all logging at full detail. :: + + export PVXS_LOG="*=DEBUG" + +.. doxygenenum:: pvxs::Level + +Controlling Logging +^^^^^^^^^^^^^^^^^^^ + +By default, all loggers have level Err. +It is recommended that user applications prefer configuration +through the environment variable **$PVXS_LOG** by calling `pvxs::logger_config_env`. + +.. doxygenfunction:: pvxs::logger_config_env() + +If this is undesirable, logger levels may be (reset) manually. + +.. doxygenfunction:: pvxs::logger_level_set(const char *, Level) + +.. doxygenfunction:: pvxs::logger_level_clear() + + +Logging from User applications +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To emit log messages from user code, a new logger should be defined with `DEFINE_LOGGER` +which will be usable within the current translation unit. +It is allowable for multiple loggers to have the same name. + +Logger names beginning with "pvxs.*" is reserved for internal usage, +and must not be present in user code. + +.. doxygendefine:: DEFINE_LOGGER + +.. doxygendefine:: log_crit_printf + +.. doxygendefine:: log_err_printf + +.. doxygendefine:: log_warn_printf + +.. doxygendefine:: log_info_printf + +.. doxygendefine:: log_debug_printf + +.. doxygendefine:: log_printf + +.. doxygenstruct:: pvxs::logger + :members: + +Identification +-------------- + +Compile time access to PVXS library version information. :: + + #include + namespace pvxs { ... } + +.. doxygendefine:: PVXS_VERSION + +.. doxygendefine:: PVXS_ABI_VERSION + +.. doxygendefine:: VERSION_INT + +eg. to conditionally compile based on library version. :: + + #if PVXS_VERSION < VERSION_INT(1,2,3,4) + // enable some compatibility code + #endif + +.. doxygenfunction:: pvxs::version_int + +.. doxygenfunction:: pvxs::version_str + +.. doxygenfunction:: pvxs::version_abi_int + +.. doxygenfunction:: pvxs::version_abi_check + +Unit-test helpers +----------------- + +Extensions to epicsUnitTest.h :: + + #include + namespace pvxs { ... } + +.. doxygendefine:: testTrue + +.. doxygendefine:: testFalse + +.. doxygendefine:: testEq + +.. doxygendefine:: testNotEq + +.. doxygendefine:: testStrEq + +.. doxygendefine:: testStrMatch + +.. doxygendefine:: testArrEq + +.. doxygendefine:: testShow + +The testEq() macro and friends expand to a function which returns a `pvxs::testCase` instance +which may be used as a `std::ostream` to append text describing a test. eg. :: + + testEq(1, 1)<<"We really hope this is true."; + if(testNotEq(1, 2)<<"shouldn't be true") { + // further conditional tests if 1!=2 + } + +.. doxygenfunction:: pvxs::testThrows + +.. doxygenfunction:: pvxs::testThrowsMatch + +.. doxygenclass:: pvxs::testCase + :members: + +IOC Testing +^^^^^^^^^^^ + +Additional helpers for testing IOC applications. :: + + #include + namespace pvxs { namespace ioc { ... } } + +When possible, use of the ``TestIOC`` class is recommended for both +forward and backward compatibility with EPICS Base (>= 3.15.0.1). + +.. doxygenclass:: pvxs::ioc::TestIOC + + +Utilities +--------- + +Misc. utility code. :: + + #include + namespace pvxs { ... } + +.. doxygenfunction:: pvxs::escape(const std::string&) + +.. doxygenfunction:: pvxs::escape(const char *) + +.. doxygenfunction:: pvxs::escape(const char *, size_t) + +.. doxygenfunction:: pvxs::cleanup_for_valgrind + +.. doxygenclass:: pvxs::SigInt + +.. doxygenfunction:: pvxs::target_information + +.. doxygenclass:: pvxs::MPMCFIFO + :members: diff --git a/_sources/value.rst.txt b/_sources/value.rst.txt new file mode 100644 index 000000000..280f01016 --- /dev/null +++ b/_sources/value.rst.txt @@ -0,0 +1,174 @@ +Value Container API +=================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + nt + typedef + +.. code-block:: c++ + + #include + namespace pvxs { ... } + +`pvxs::Value` is the primary data container type used with PVXS. +A `pvxs::Value` may be obtained via the remote peer (client or server), +or created locally. See `ntapi` or `typedefapi`. + +`pvxs::Value` is a safe pointer-like object which, maybe, references +a node in a tree of sub-structures and leaf fields. +This tree will be referred to as a Structure as it behaves +in many ways like a C 'struct'. + +For example, the following code: + +.. code-block:: c++ + + Value top = TypeDef(TypeCode::Struct, { + members::Int32("fldname"), + }).create(); + + top["fldname"] = 1; + + fld = top["fldname"]; + fld = 2; + +Is analogous to the following pseudo code. + +.. code-block:: c++ + + // pseudo-code + struct anon { + int32_t fldname=0u; + }; + void* top = new anon; + + static_cast(top)->fldname = 1; + + void* fld = &static_cast(top)->fldname; + static_cast(fld) = 2; + +With the chief functional difference being that the analogs of the casts are made safe. +Also, the storage of the underlying Structure will be free'd when no more Values reference it. + +A Value which does not reference any underlying Structure is not valid, or "empty". + +.. code-block:: c++ + + Value dummy; + assert(!dummy.valid()); + assert(!dummy); // operator bool() is an alias for valid() + +An invalid Value may be returned on error by some methods. +All operations on an invalid Value should be safe and well defined. + +.. code-block:: c++ + + Value top(nt::NTScalar{TypeCode::Int32}.create()); + int32_t val = top["nonexistent"].as(); + +In this example, the operator[] lookup of a non-existent field returns an invalid Value. +Attempting to extract an integer from this will then throw a `pvxs::NoField` exception. + +Value +----- + +Field Lookup +^^^^^^^^^^^^ + +Access to members of structured types is accomplished through `pvxs::Value::operator[]` or `pvxs::Value::lookup`. +These two methods differ in how errors are communicated. +operator[] will return an "invalid" or "empty" Value if the expression does not address a member. +lookup() will throw an exception describing where and how expression evaluation failed. + +Iteration +^^^^^^^^^ + +`pvxs::Value` instances pointing to a non-array structured data field (Struct or Union) +may be iterated. Iteration comes in three variations: `pvxs::Value::iall`, `pvxs::Value::ichildren`, +and `pvxs::Value::imarked`. + +For a Struct, iall() is a depth first traversal of all fields. +ichildren() traverses all child fields (excluding eg. grandchildren +and further). imarked() considers all fields, but only visits +those which have beem marked (`pvxs::Value::isMarked`). + +For a Union. iall() and ichildren() are identical, and will +visit all possible Union members, excluding the implicit NULL member. +Traversal does not effect member selection. +imarked() for a Union will visit at most one member (if one is selected)> + +Iteration of Union may return Value instances +allocated with temporary storage. Changes to these instances +will not effect the underlying structure. + +Iteration of other field types, including StructA and UnionA is not implemented at this time, +and will always appear as empty. + +.. doxygenclass:: pvxs::Value + :members: + +.. doxygenstruct:: pvxs::NoField + +.. doxygenstruct:: pvxs::NoConvert + +.. doxygenstruct:: pvxs::LookupError + +Array fields +------------ + +Array fields are represented with the `pvxs::shared_array` container +using void vs. non-void, and const vs. non-const element types. + +Arrays are initially created as non-const and non-void. +After being populated, an array must be transformed using +`pvxs::shared_array::freeze` to become const before +being stored in a `pvxs::Value`. + +.. code-block:: c++ + + shared_array arr({1.0, 2.0}); + Value top = nt::NTScalar{TypeCode::Float64A}.create(); + + top["value"] = arr.freeze(); + # freeze() acts like std::move(). arr is now empty + # only the read-only reference remains! + +The `pvxs::shared_array::freeze` method is special in that it +acts like std::move() in that it moves the array reference into the returned object. +freeze() requires exclusive ownership of the reference being frozen. +An exception will be thrown unless `pvxs::shared_array::unique` would return true. + +Array values may be extracted from `pvxs::Value` as either const void or const non-void. +The const non-void option is a convenience which may **allocate** and do an element by element conversion. + +.. code-block:: c++ + + # extract reference, or converted copy + arr = top["value"].as>(); + +When it is desirable to avoid an implicit allocate and convert, +an array can be extracted as "const void". +This does require calling `pvxs::shared_array::original_type` to find the `pvxs::ArrayType` +of the underlying array prior to using `pvxs::shared_array::castTo`. + +.. code-block:: c++ + + # extract untyped reference. Never copies + shared_array varr = top["value"].as>(); + if(varr.original_type()==ArrayType::Float64) { + # castTo() throws std::logic_error if the underlying type is not 'double'. + shared_array temp = varr.castTo(); + } + +.. doxygenclass:: pvxs::shared_array + :members: + +.. doxygenfunction:: pvxs::elementSize + +.. doxygenclass:: pvxs::detail::Limiter + :members: + +.. doxygenenum:: pvxs::ArrayType diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 000000000..8549469dc --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/alabaster.css b/_static/alabaster.css new file mode 100644 index 000000000..0eddaeb07 --- /dev/null +++ b/_static/alabaster.css @@ -0,0 +1,701 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 000000000..4e9a9f1fa --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/custom.css b/_static/custom.css new file mode 100644 index 000000000..2a924f1d6 --- /dev/null +++ b/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 000000000..527b876ca --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 000000000..db0704bd5 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.3.1', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/favicon.png b/_static/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..e5f79c4a0478fa27757e09ff4eae9792ac21fabc GIT binary patch literal 1432 zcmV;J1!ww+P)pF8FWQhbW?9;ba!ELWdL_~cP?peYja~^aAhuUa%Y?FJQ@H11tm#D zK~z|UwUL`A8GUP`O2STCVSFWv;jqZj`n z?o9+mii?3*L8|ejQHx*%5&u-IG;Nh8*=*X)+8#vO`5oe}*)*xuU;AKT=Djy>zVrUg ztdvY9g(OKxl7va-xVEUAs}pXwTU1n3h@PGvp{lCLWHKU?$%y6J-(e08A3jVx9%pE1h}*YsbK}Mh9z1wp zDJ~ZXM`7$u+P{B4n>KCY&6_tCPm&}wO%s}?Eh!L3F+-9hrl+S-RTa0}ZSe{zo6Rm6 z2&Xw18X7{DWq$nl!N9-(6%`eblO|965~A()w&VQg%SY&J_rM+bw0 zgLu8(1s5-cC!CN!Rbyi#moHzo1S2CO%*@Q-_xtB9G7N)6B0(S!U~+O&0Myjf{F684 z<$y_d@7|@Ytqmc5AJX)eEX#yKAy%wdVaZG&e+{5i6-bgqS63H_M1pucZj;T;%@GcV zId<$A4u>88)YQ~pgKz@0w6w5l)he5yuC9)zrY00cVaJXg7C#n?kxHd#Z*MPY&;+q| z?b=0!L@L){BuPS16waJE!^e*wak*Ro^z`&FJw45xJ9jL-!Zn5CHEY)V5k%P>5JJ$} z+6utHzyOd>zK0JV(%ISh=c56-t_xk)7Ys{T0Fb|!T3cID6a|2L_wM0xxj1m(0Fdt; zj~_p_fj0TkXcWkMBA3gR1>q1vV1A{jv$K=u&!6+{+cy+Np`)Y2%9qN@NNQ77{Mj#Ndw5Mo2}v;nVp@@hoID*U+9%1M~)DQL}+MeAP@-HeMNs(J1%t-$#~ZTaPHTSvqeqXD%jMX;d$&zyp5)4v zE9}~}i&!kixpU{(x^*jsc8b>&f{{wSdeZ5%D0W#X7n=0*=TG+T-OHCRUwHfWE$i2> zFR5E>Z+3RJG=M@73vF!9FI>1lI2>lfh7D9zRngbiXVaaSm_Sh!Mn^|ky?QnE_4OP& zbO@i%SH29rUa#c!dL^*uLvh8tfB&AVSFdvI+BIZZ=Gn7nL?RJO_uad9G&VL8kH^`v zWeZhRRrL4wbMxlSyn)3$wbJRdDEw4a6{@O=iHQjj3C>kH`2PJnD_5?xd2eoR&f-a#Oh$M-o<-l~W^M=}h(@E-*VnUo^X9ymcZ7rqS_3!)qlAp}pKJ|&mS*? m23Q^dCMA=}lI^_EL;nFYR>Z6@kFg5?0000s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/_static/forkme_right_darkblue_121621.png b/_static/forkme_right_darkblue_121621.png new file mode 100644 index 0000000000000000000000000000000000000000..146ef8a800602169cf78c686fc5a6d138a76bc0a GIT binary patch literal 7791 zcmV-#9+2UQP)O>+M%?x9Q-Aclg+SU{aR>iZ-V5ENM}s?g?o3TCz>p076pgIvo9@XSFn67!Z(L}aTexp zAcOn{GYF{63{x3Y|KXge7Rgs|WVGqumV|_UKRatZba(eaMP)S%4i5UolZ=m#gN&6H zmI^z-ZZEFv>uz~$@a{kh`_f(c8kBDZWBCYFpnBH^sV@HRRs-u`N=owgva>frJ9_~y z=NB-xxa}8DG&D36Hs@wTUtd2CdUUM)X%#d;KqN)YP2# z_^;<-cz77hCZpdx(Ob7}LG_JVh>MGXRhb#7OC#dmSQNY@PELi3`5Qx|LfHxOUyn#Cxw_JmE!)7C}zd2I%VPfy&CNs?N3sbt=3g7;AQ! zieJO>w_x=xDdui%V$*mbN0Lu~sdb3uD_gP4P(_*Zq z#wHuqu7V6fVDh7K!<{>KprN4&EU77wlbw|o9cL2a-N#JjF=K^CL@>sZ$_=F@<#g*0 z5wnaX3v>g(;b-KeR9gt$0Zy*d+o_XgKjL$uM`*AKXdnQlpi zT|4tENoI=>?>=TKj~Q!8NT@Y?<9g_38mqjbimLE410?Cj>F$B+wm9*5FHcB-j0_93 zw6sEzv{xt?%a@?SpI5yzrwlB!*=*gkDGNGT%E`ZS75e*cc^6O`Fu8@53S7!_4hdNT zn4)npQC?9|-Q=jY3SiBA`cngI+NrRvuFm$i^Pe%68Ud5hI75JPDpciks$X)t+`Z~p zq^+&1hs4C?ux9n@)Ue2SQEu=hQ>lJt+Kjax#sH;0M#J}4|I@o=xu2~MXv^(nyF z^T0P@?V8na=-DIuRi}sPj;(mPA#1}r=<3E4T~XED(Im(TS9Kynu zf+cN**8t_@fMU0M?*AqnJ^Ty->*(P_3R#W8R=nI$?`R;6wR6Yzv_xZ?5bwTZDsM0r z?iJ=_Z-5@AWf(Egi#pwuCp|Xl6Av&TJ$K|;`bvGhgX&~w-~BaXtfTUCHK>?tbi~HS zP@^CAi4~WW3i0kMrt$`3(OzLgBe7L(ZWg7Vsju~%08VAqrv}uIpZO_#?duOfQBg5t ztZ%`AeUIqa%KdBJ+S*1fJV{B3khg8C*emoks5}MMjp`e=4?g@DhKGhBCD}A3mePQW zJp?tN&R_Tp&Yt}>?fE^lcR!pv_b0|yzZnxq`snZPr%sFTh;T@^q=~&kU#35ArNV@S z1Zyseca{nZt`$xo-c?%4De(?zs3Xs4Qr9j26r zpU1R?fWkERAk$MAXaD;*(9_+kVk_w(8r+l@^bsB&25VQZg7%IM(daiDpz;J*k_rcU6DNNu@sIpCw=+<^_R32T!2pIq`s$JW zU@s~e4J>Wp-7UzXqn82J*LwT<;Cf+EwWGFT-dEmz3My}u8+akIth_?^xAhft(3BLM zGK0PK<|zWy3&(y=I_v0>|0L#m;s*y^#ZQB*x6~jqi~%luI*Ex1bcnXCwVkaH3+Fv! z`5aW90?TMJT61%|EjKSMh7ezOdx~n%$p}E{h`J}!H)6Khkt+w#%S5OI}~m* zxD)JSSKTp|EV&1;7auzv%F8RNnj3G-Tk#$=8-LUj@$RU1*gpOI5{!(Du+?0W9(U~lm(N@A9yD8j*b`vgY-+Myy;cOvS=!mUc@u5zj1Me{buiuGzTbVjzeIq-l^|-W z7mmHm0JR$4I(?EZiQPsBP^in^{N?K;$j1W~KAqayI{4H39}wWvEta(Tx(OXLn}6IB zVDJenFJwla$pQz*zA0NxWo=&S( zdvVFU67PNiDo=rxl9EEe>gec#OZit+2UhjMUFlemR)Z2NA)rXSzaxov{P^uNZ%BYT zi-0=J9!=1cK!t%l?@}-REhs51MN^P@QEmwGmj~iWDy*rgvHj)a^Ds0tq%#E>od&sZ zkBo?b*Is#10hBD>^?<^!8R>UAVX}LKJo;}9K-G;}h>eYg%#4hAvsdUhOyv#6ii?Yr z_6qy^;QDntrNr?{4Oq9r>m66cJ&aNz0*V(#5oCD#@FNGnZZDazsn1;m2L}T(X*V_c zRR+8%h~I(A6JSNfm>)NpOxDcIm2#^}(Zt13xrT*W3R58h3I#mgVyOY|V@(VJRm84Q z757O3%b1i1n{qbN@vqDISE`yDYXTNnehDgXRNiwpWl?uSd1V#cVrgh1V7+?$80_Bt zC8;%rf#|^gN8t;9e;?F49I9FusC1PArpbaUDk>6It;&Fo_73z$4OsE+x1jPASgC1g zR_;!G>0&+%4h^|q70S;6SB2QL_xed2{QkFR>GNOv#vWCbT@50G4nKw|0SkS*a8tan z$R3b;g+cy|cu&N8bybyO3X+;Ks*a^zy&-l{f1NmWnhAXqr9P~@8`J<%fe=qIQ|~)J znKMDPT^*>aii^w0w<}OhLHrt2o&u|{x5viaiSON&H>&ckN?w}%z9M@uocqI{rIcsT z$}$x8SP;d76TCFRb=hQqh1GWK#ro?f7s!Wn!-jR1xaG+KwWZ_N>CaoKFfl2~%H4^J zi%a!SVANq#lQ9YE>K&TzA%TnDXf z9q{?ZO98Vg^n0fA24gigG}!X5T!Z+ySSm(hQBqUNGH4_>F^R#TNq#IPDuBWsElgui z|L9+(?Hg55Rbi}&UuQh5`u+zW!7$T%X{jsH0wopB8Blp66}sGs*$Pa9Dt(bul@cXD zt!61tsk}db>}A^G!T2s)C3*rZ6ztVE&=f@4D+~lvkU5k7yp;;?SrTI9?!;9%KtQu9 zRId!B`~>ig{Ugj5Sg4rhWQYVb&n$t|>DPwiC*3uFCk3TsNA)z6(%Dd;D#TvHK zw#@()M$KlU3Q#{KJ@wqtpU}s+&GYyZKcwHa`zv3ZGF$OzXl#P>=Rc>TXvQStoT|Jp zga8RoG!}pn-HEMP8`jdvnoF0j$Q`7TKvMLT^xLtHb@J3N>8KcXh5qHkb1rsz@PTi` z3-v#zk2!0BT3gBYC&O5{Z#ifmgxuV0SQZs&v6qzCRC|SftFZzi{dsFu7#SI94dySln;+?{ymj%}*FLW4%Tb2ATqq8S0SPHyZ&HyLEC7he1YZRKbRp*l-Q zr}EF(bTcvnb#)H-=;QNrwva6rEdK7@5OARK6j(QJ-n11Ipee{gx2?(Q&IS%FEPCRJ zoZtWMT`)1dg)KAhl0^|{x)_|G?QEDzcY|wy00aD{ob0ric>f(B5OC?wTd6QCJltgp zf_1EZ*GXviexfMKab-wVbvJ~dN`FitYe|41ePtbvNl?lC#Cw0#+nzP@)TG& zK;Xis7ir9i))d5D+l+FUv+zO6I5gLM4hrXVI` zBCKDx)^AKf7Q#FV&kCgUB3id>&Vi`NNGP8OcLa@`}ze^UI_Cz zJkeM+K&`}9G(*Dy0!pKwtHV!Wd}`VQI(dT|)+bKk!3hLZ1POJM+>T7!Ix-EZJ5RO5 z#2>D~wNb5RE9`l%s;YrCt1@8a%JfvG>rSZ{%O@IZ-ljiqrNX%Qcq?}&Mt46&yz2_2 z8vjx3UxFhzfs}(uULDFWJpPgWOq`DgC`^m596u%x5>Ns`h2P&p z;2pc223vO=jz$7jO!Ts}%lQl6P?>_vC}Rnx@)Bd=00EUd@ffBcssfaJpo03}K`WBf zEY>aeY+-XCt|Ad+_%kocCwE)`R#oxU5g8c)t1~m8qqEazrXT`TUIG>$AV8)dOfY{= z0|bUO!ynKY+3qMOch{uSAjYz&C|XdUJ-9DS zLFVo1&)ciQuJ(E|1yS6IQ+01lWo78r!$A%_n2Ml5(T*!b67LGR!MStq!?9z>RjWjR ziCSp7y1T(%TnhIrxrZ$(l4pFcP%zaDq{1Ylk^Hgn(8HB0S1Bdxi=<->5y-#v39;2f z5AT~z52gZqa6{J{OLRpO7IJ*@R6 z)o)7cr-HFh#KpxzW=1-+;s60Jnt}+X@&RKF-0HX0*EcX`NP}(LHj_1@TegycaO|by zkdwPp0*gEZQv;}nAA=p+w-Iaco-On&0;d74;Q1$ioG_;8a0*fC5J9_w8 zDw4i>`~{k?Gb$bGQsKbB0Jwa+GQBfEK%_q(r^1-nSSxoYzINR%?-h<1HBwLpb&g^mOA;k6!!PzX%#Xv zj#0--N?J}+?4SBYW|X1h&ec(b{(&ddvkz z4k!}!3}`eKg*}o;YOOg%t4DO8u@{$2SRjqYQFjdR9qqVRIK4(cp{Zs`W8of zQ<5P&Ya^u}F4pxP?|fCqXYJt0=^e7!nwp`=-1gv8lo}&wEXpaDkXLZ(9QRBG9#Xa2 zOX+XqUBD5KOV5~ zcK`lIr~t}qRz-!y^gY{|-ul&BvdOJWUzNC8o85OdxKD++SD2Ht5qfDrXH`|}&Du$6 zERp{FAQhr1NPfXpVhFt{h+&L*g=heR+Dc&|X?y42pMKKy)3`Fk)gm6eaH^~Bprk=< z)m=*vWD4SFgtXKYoMfLC9XB~s5W!S_#8_ww!rh5WODm}VX`+>(gcT<>_Nl$GUXZ=s z-#%j_p^g?u%DlpdO0K9k>>X^yjCk&}=qaxjQk=)lvMh)B;{Ruh3{pq5>&DoO=HJrwma0 z=zFm2fE9OSt*?E34|PPKmjfAy*o$HB-hYAa-X569&ItD{X+Wpci(l2$;BrmABfmlJ z3Q+kmu;Swr=#)--dk1P6{r~)^BletqKKkH2(otDC+liq#p!iA=g+1;iVmU&x<~|@> zb5C4uz^7w2n_&Gq$+zqCi zv-#1%ySJJ}Nns9%_wKGP8#*P2g)gOJ_B!5Bl^a~`0%Q@1F}Mf#f~sSx)Hv5TOmXM9r-b%FHEnRjg28gxVE+qC@Cqc=!&sdvWQnMEaXUsj#}b z+V;VRf2BjJ$;l>78gw`E1RMPjP-w8mQ{MB(enBh02nI}KDh$nN-?0~dV+O8FvC{$# zN75~67Qs|=P`p=GR$I}X7~6mqQ;@M4i{?CoWNM4x!a)K&^`ZWfrczAbJqQoa;^^L{ zo6WE(d!y*5nu{6>?YNCbqifi>VhS>`#!?%8&@|PTj)TifYl?cxU6@(A6`-2K;$3YD zQc+P!Ez0hJrOcebE>dJD6zW_@P1VPJ!sjGFHFtraQimx z6^4h0qwTe-HQ9GlZ$6Pzd$F6z?umkRIt=;o#t)U@8%w zn}VP_@k&c7Y}=ZvH3gaB5Sl80HC7E^e|eu3-HFi@q_nI;fJ%gS#CvI35SfC+#6+u1 zK}7l!!15p!c67AcxI1y`iew?wMR-rVW96N@6IWDJlQ)%MDiK~7-7C2hXKh?ZGnfTa ziSP*d*U63 zjjIO;3~9#738oT^<-xFVJWPRxwILzX-zyZFN@y$!1Xdlpy*+T-itfZ_lgW)KhyaxU z)-?ADhlWRJ*!Z&OC@3r}p7LIyNPi*~x-kXmw3U{X!P3xBNE>AeB80jS@1B~1DDK4M znIM=-gvWb@DtBTC4h|MfCBi$56&V?6KdxN$H&L%1_+4s zCsN@wQ(;SUvyHnGCr_|fDAJ!ug;O*I3Ab{0VmxB6n1TqV5{%`6c(1K<&}=~Txx&#W zf~iD!%2>hjxx&ZLow%!~hZ_CR_)IXB2u~R6_`pE_Deg|ZbH_F+l#11#i0Q5h@%u)) z+Z{j0+o7SM1L#hShP9=#DTn}-h^Ye0DKptH1J+9hFbv9DK4{#ajc&uiSB82jD@Q;C==V{xV$ku`ZxdrQsp!y_ZZO*fl=fbPVCsYH0fST5%3 zYODL%o!bL1I~p21FDZmaCC;&Rw036RsOM?`ji elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (trac-9521) + // Strict HTML recognition (trac-11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See trac-6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (trac-9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see trac-8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (trac-14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (trac-11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (trac-14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (trac-13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (trac-15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (trac-12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (trac-13208) + // Don't process clicks on disabled elements (trac-6911, trac-8165, trac-11382, trac-11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (trac-13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (trac-504, trac-13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur if we're currently inside + // a leveraged native-event stack + _default: function( event ) { + return dataPriv.get( event.target, type ); + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (trac-8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + + // Unwrap a CDATA section containing script contents. This shouldn't be + // needed as in XML documents they're already not visible when + // inspecting element contents and in HTML documents they have no + // meaning but we're preserving that logic for backwards compatibility. + // This will be removed completely in 4.0. See gh-4904. + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var rcustomProp = /^--/; + + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (trac-15098, trac-14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + +var whitespace = "[\\x20\\t\\r\\n\\f]"; + + +var rtrimCSS = new RegExp( + "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", + "g" +); + + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (trac-8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + isCustomProp = rcustomProp.test( name ), + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, trac-12537) + // .css('--customProperty) (gh-3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + // trim whitespace for custom property (issue gh-4926) + if ( isCustomProp ) { + + // rtrim treats U+000D CARRIAGE RETURN and U+000C FORM FEED + // as whitespace while CSS does not, but this is not a problem + // because CSS preprocessing replaces them with U+000A LINE FEED + // (which *is* CSS whitespace) + // https://www.w3.org/TR/css-syntax-3/#input-preprocessing + ret = ret.replace( rtrimCSS, "$1" ); + } + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (trac-7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug trac-9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (trac-7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (trac-12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // Use proper attribute retrieval (trac-12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classNames, cur, curValue, className, i, finalValue; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classNames = classesToArray( value ); + + if ( classNames.length ) { + return this.each( function() { + curValue = getClass( this ); + cur = this.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + for ( i = 0; i < classNames.length; i++ ) { + className = classNames[ i ]; + if ( cur.indexOf( " " + className + " " ) < 0 ) { + cur += className + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + this.setAttribute( "class", finalValue ); + } + } + } ); + } + + return this; + }, + + removeClass: function( value ) { + var classNames, cur, curValue, className, i, finalValue; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classNames = classesToArray( value ); + + if ( classNames.length ) { + return this.each( function() { + curValue = getClass( this ); + + // This expression is here for better compressibility (see addClass) + cur = this.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + for ( i = 0; i < classNames.length; i++ ) { + className = classNames[ i ]; + + // Remove *all* instances + while ( cur.indexOf( " " + className + " " ) > -1 ) { + cur = cur.replace( " " + className + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + this.setAttribute( "class", finalValue ); + } + } + } ); + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var classNames, className, i, self, + type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + classNames = classesToArray( value ); + + return this.each( function() { + if ( isValidValue ) { + + // Toggle individual class names + self = jQuery( this ); + + for ( i = 0; i < classNames.length; i++ ) { + className = classNames[ i ]; + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (trac-14686, trac-14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (trac-2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (trac-9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (trac-9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (trac-6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // trac-7653, trac-8125, trac-8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (trac-10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes trac-9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (trac-10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket trac-12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (trac-15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // trac-9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (trac-11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // trac-1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see trac-8605, trac-14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // trac-14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Building from Source

+

Begin be fetching all needed source.

+
git clone --recursive https://github.com/epics-base/pvxs.git
+git clone --branch 7.0 https://github.com/epics-base/epics-base.git
+
+
+

Prepare the PVXS source tree with the location of epics-base:

+
cat <<EOF > pvxs/configure/RELEASE.local
+EPICS_BASE=\$(TOP)/../epics-base
+EOF
+
+
+

Build Base:

+
make -C epics-base
+
+
+

Alternatives to install or build libevent >=2.0 .

+

On RHEL7 and later.

+
yum install libevent-devel
+
+
+

On RHEL6 and earlier.

+
yum install libevent2-devel
+
+
+

On Debian/Ubuntu.

+
apt-get install libevent-dev
+
+
+

To build from source (Requires CMake):

+
make -C pvxs/bundle libevent # implies .$(EPICS_HOST_ARCH)
+
+
+

For additional archs: eg.

+
make -C pvxs/bundle libevent.linux-x86_64-debug
+
+
+

Finally, build PVXS:

+
make -C pvxs
+
+
+
+

Running Tests

+

It is recommended to run automatic unittests when building a new (to you) version +of PVXS, or building on a new host.

+
make -C pvxs runtests
+
+
+
+
+

Cross-compiling libevent2

+

The bundled libevent may be built for some cross compile targets. +Currently only cross mingw.

+
make -C pvxs/bundle libevent.windows-x64-mingw
+
+
+
+
+
+

Including PVXS in your application

+

Including PVXS in an application/IOC using the EPICS Makefiles is straightforward. +Add PVXS to the application configure/RELEASE or RELEASE.local file.

+
cat <<EOF >> configure/RELEASE.local
+PVXS=/path/to/your/build/of/pvxs
+EPICS_BASE=/path/to/your/build/of/epics-base
+EOF
+
+
+

Then add the pvxs and pvxsIoc libraries as a dependencies to your IOC or support module. eg.

+
PROD_IOC += myioc
+...
+myioc_DBD += pvxsIoc.dbd
+...
+myioc_LIBS += pvxsIoc pvxs
+myioc_LIBS += $(EPICS_BASE_IOC_LIBS)
+
+
+

The “pvxsIoc” library should only be included for IOCs. +It can, and should, be omitted for standalone applications +(eg. GUI clients).

+

Add the pvxs library as a dependency to your executable or library. eg.

+
PROD_IOC += myapp
+...
+myapp_LIBS += pvxs
+myapp_LIBS += Com
+
+
+

libevent will be automatically added for linking.

+

For those interested, this is accomplished with the logic found in +“cfg/CONFIG_PVXS_MODULE”.

+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/cli.html b/cli.html new file mode 100644 index 000000000..0ffe74b3a --- /dev/null +++ b/cli.html @@ -0,0 +1,183 @@ + + + + + + + + + Command Line Tools — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Command Line Tools

+

A basic set of command line tools are currently provided to facilitate testing and development. +End users should prefer the CLI tools from the pvAccessCPP module +for day to day use.

+
    +

  • pvxcall - analogous to pvcall

    • +

  • pvxget - analogous to pvget

    • +

  • pvxinfo - analogous to pvinfo

    • +

  • pvxmonitor - analogous to pvmonitor or pvget -m

    • +

  • pvxput - analogous to pvput

    • +

  • pvxvct - UDP search/beacon Troubleshooting tool.

    • +
+
+

Troubleshooting with Virtual Cable Tester

+

The pvxvct executable is capable of listening for UDP searches from PVA clients, +and/or UDP beacons from PVA servers. +Together with pvxget they can be used to investigate communications issues.

+

On the host with the PVA server (IOC or otherwise), +run the following to listen for searches.

+
$ pvxvct -C -P my:random:test:pvname
+
+
+

While this is running, switch to the host where the PVA client resides +and run

+
$ pvxget my:random:test:pvname
+
+
+

If all goes well, the pvxvct process should print several lines +as search requests are received. eg.

+
$ pvxvct -C -P my:random:test:pvname
+2020-04-09T19:37:01.146272170 INFO pvxvct 192.168.1.1:47357 Searching for:
+2020-04-09T19:37:01.146442772 INFO pvxvct   "my:random:test:pvname"
+...
+
+
+

Note that pvxvct does not use the $EPICS_PVA* environment variables +and by default listens on 0.0.0.0:5076. Sites using a non-default +port will need to add -B 0.0.0.0:<port>.

+

If searches are not seen, then investigate client Configuration +($EPICS_PVA* environment variables), and firewall settings.

+

If searches are seen, then switch to pvxget -d ... and a real PV name. +The output will be very verbose. Look for lines like the following:

+
$ pvxget -d my:real:pv:name
+...
+2020-04-09T19:44:46.064937960 DEBUG pvxs.client.io UDP search Rx 53 from 192.168.1.1:5076
+2020-04-09T19:44:46.064947396 DEBUG pvxs.client.io Search reply for my:real:pv:name
+2020-04-09T19:44:46.065151400 DEBUG pvxs.client.io Connecting to 192.168.1.1:5075
+2020-04-09T19:44:46.065200101 DEBUG pvxs.client.io Connected to 192.168.1.1:5075
+...
+2020-04-09T19:44:46.067255960 DEBUG pvxs.client.io Server 192.168.1.1:5075 accepts auth
+
+
+

Repeat with pvxinfo in place of pvxget.

+

If the ...accepts auth... line is seen, but no subsequent error message, +then see Reporting a Bug and attach the output of pvxget -d ....

+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/client.html b/client.html new file mode 100644 index 000000000..10e6571d0 --- /dev/null +++ b/client.html @@ -0,0 +1,1273 @@ + + + + + + + + + Client API — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Client API

+

pvxs::client::Context represents a PVA protocol client.

+
#include <pvxs/client.h>
+namespace pvxs { namespace client { ... } }
+
+
+
+

Configuration

+

The recommended starting point is creating new context configured from EPICS_PVA_* Environment variables. +Use pvxs::client::Context::fromEnv().

+
+
EPICS_PVA_ADDR_LIST

A list of destination addresses to which UDP search messages will be sent. +May contain unicast and/or broadcast addresses.

+
+
EPICS_PVA_AUTO_ADDR_LIST

If “YES” then all local broadcast addresses will be implicitly appended to $EPICS_PVA_ADDR_LIST +“YES” if unset.

+
+
EPICS_PVA_NAME_SERVERS

A list of the addresses of listening TCP sockets to which search messages will be sent.

+
+
EPICS_PVA_BROADCAST_PORT

Default UDP port to which UDP searches will be sent. 5076 if unset.

+
+
EPICS_PVA_CONN_TMO

Inactivity timeout for TCP connections. For compatibility with pvAccessCPP +a multiplier of 4/3 is applied. So a value of 30 results in a 40 second timeout. +Prior to 0.2.0 this variable was ignored.

+
+
+
+

New in version 0.3.0: EPICS_PVA_ADDR_LIST may contain IPv4 multicast, and IPv6 uni/multicast addresses.

+
+
+

New in version 0.2.0: Added EPICS_PVA_NAME_SERVERS.

+
+
+

New in version 0.2.0: Prior to 0.2.0 EPICS_PVA_CONN_TMO was ignored.

+
+
using namespace pvxs;
+// Context configured from process environment
+client::Context ctxt = client::Context::fromEnv();
+
+
+

Programmatic configuration can be accomplished by explicitly filling in a pvxs::client::Config.

+
+
+

Making Requests

+

A pvxs::client::Context instance is the entry point for all client network operations. +Begin by calling one of the info(), get(), put(), rpc(), or monitor() methods. +Each of these methods returns a *Builder object which can +be used to provide additional configuration in what are in +effected named arguments.

+
+
+class Context
+

An independent PVA protocol client instance

+

Typically created with Config::build()

+

Context ctxt(Config::from_env().build());
+
+
+

+
+

Public Functions

+
+
+constexpr Context() = default
+

An empty/dummy Context.

+
+ +
+
+explicit Context(const Config&)
+

Create/allocate a new client with the provided config. Config::build() is a convenient shorthand.

+
+ +
+
+const Config &config() const
+

effective config of running client

+
+ +
+
+void close()
+

Force close the client.

+

~Context() will close() automatically. So an explicit call is optional.

+

Aborts/interrupts all in progress network operations. Blocks until any in-progress callbacks have completed.

+

+
Since

1.1.0

+
+
+

+
+ +
+
+inline GetBuilder get(const std::string &pvname)
+

Request the present value of a PV

+

Simple blocking

+

Context ctxt(...);
+auto result = ctxt.get("pv:name")
+                  .exec()
+                  ->wait();
+
+
+

+

With completion callback

+

Context ctxt(...);
+auto op = ctxt.get("pv:name")
+              .result([](Result&& prototype){
+                 std::cout<<prototype();
+              })
+              .exec();
+// store op until completion
+
+
+ See GetBuilder and Get/Info for details.

+
+ +
+
+inline GetBuilder info(const std::string &pvname)
+

Request type information from PV. Results in a Value with no marked fields.

+

Simple blocking

+

Context ctxt(...);
+auto result = ctxt.info("pv:name")
+                  .exec()
+                  ->wait();
+
+
+

+

With completion callback

+

Context ctxt(...);
+auto op = ctxt.info("pv:name")
+              .result([](Result&& prototype){
+                 std::cout<<prototype();
+              })
+              .exec();
+// store op until completion
+
+
+

+

See GetBuilder and Get/Info for details.

+
+ +
+
+inline PutBuilder put(const std::string &pvname)
+

Request change/update of PV.

+

Assign certain values to certain fields and block for completion.

+

Context ctxt(...);
+auto result = ctxt.put("pv:name")
+                  .set("value", 42)
+                  .exec()
+                  ->wait();
+
+
+

+

Alternately, and more generally, using a .build() callback and use .result() callback for completion notification.

+

Context ctxt(...);
+auto op = ctxt.put("pv:name")
+              .build([](Value&& prototype) -> Value {
+                  auto putval = prototype.cloneEmpty();
+                  putval["value"] = 42;
+                  return putval;
+              })
+              .result([](Result&& prototype){
+                 try {
+                     // always returns empty Value on success
+                     prototype();
+                     std::cout<<"Success";
+                 }catch(std::exception& e){
+                     std::cout<<"Error: "<<e.what();
+                 }
+              })
+              .exec();
+// store op until completion
+
+
+

+

See PutBuilder and Put for details.

+
+ +
+
+inline RPCBuilder rpc(const std::string &pvname, const Value &arg)
+

Execute “stateless” remote procedure call operation.

+

Simple blocking

+

Value arg = ...;
+Context ctxt(...);
+auto result = ctxt.rpc("pv:name", arg)
+                  .arg("blah", 5)
+                  .arg("other", "example")
+                  .exec()
+                  ->wait();
+
+
+

+

With completion callback

+

Value arg = ...;
+Context ctxt(...);
+auto op = ctxt.rpc("pv:name", arg)
+              .result([](Result&& prototype){
+                 std::cout<<prototype();
+              })
+              .exec();
+// store op until completion
+
+
+

+

See RPCBuilder and RPC for details.

+
+ +
+
+inline MonitorBuilder monitor(const std::string &pvname)
+

Create a new subscription for changes to a PV.

+

MPMCFIFO<std::shared_ptr<Subscription>> workqueue(42u);
+
+auto sub = ctxt.monitor("pv:name")
+               .event([&workqueue](Subscription& sub) {
+                   // Subscription queue becomes not empty.
+                   // Avoid I/O on PVXS worker thread,
+                   // delegate to application thread
+                   workqueue.push(sub.shared_from_this());
+               })
+               .exec();
+
+while(auto sub = workqueue.pop()) { // could workqueue.push(nullptr) to break
+    try {
+        Value update = sub.pop();
+        if(!update)
+            continue; // Subscription queue empty, wait for another event callback
+        std::cout<<update<<"\n";
+    } catch(std::exception& e) {
+        // may be Connected(), Disconnect(), Finished(), or RemoteError()
+        std::cerr<<"Error "<<e.what()<<"\n";
+    }
+    // queue not empty, reschedule
+    workqueue.push(sub);
+}
+// store op until completion
+
+
+

+

See MonitorBuilder and Monitor for details.

+
+ +
+
+inline ConnectBuilder connect(const std::string &pvname)
+

Manually add, and maintain, an entry in the Channel cache.

+

This optional method may be used when it is known that a given PV will be needed in future. ConnectBuilder::onConnect() and ConnectBuilder::onDisconnect() may be used to get asynchronous notification, or the returned Connect object may be used to poll Channel (dis)connect state.

+

+
Since

0.2.0

+
+
+

+
+ +
+
+inline DiscoverBuilder discover(std::function<void(const Discovered&)> &&fn)
+

Discover the presence or absence of Servers.

+

Combines information from periodic Server Beacon messages, and optionally Discover pings, to provide notice when PVA servers appear or disappear from attached networks.

+

Note that a discover() Operation will never complete with a Value, and so can only end with a timeout or cancellation.

+

Context ctxt(...);
+auto op = ctxt.discover([](const Discovered& evt) {
+                 std::cout<<evt<<std::endl;
+             })
+             .pingAll(false) // implied default
+             .exec();
+op->wait(10.0); // wait 10 seconds, will always timeout.
+
+
+

+

+
Since

0.3.0

+
+
+

+
+ +
+
+void hurryUp()
+

Request prompt search of any disconnected channels.

+

This method is recommended for use when executing a batch of operations.

+

Context ctxt = ...;
+std::vector<std::string> pvnames = ...;
+std::vector<Operation> ops(pvnames.size());
+
+// Initiate all operations
+for(size_t i=0; i<pvname.size(); i++)
+    ops[i] = ctxt.get(pvnames[i]).exec();
+
+ctxt.hurryUp(); // indicate end of batch
+
+for(size_t i=0; i<pvname.size(); i++)
+    ... = ops[i].wait(); // wait for results
+
+
+

+

Optional. Equivalent to detection of a new server. This method has no effect if called more often than once per 30 seconds.

+
+ +
+
+

Public Static Functions

+
+
+static Context fromEnv()
+

Create new client context based on configuration from $EPICS_PVA* environment variables.

+

Shorthand for 

Config::fromEnv().build() 
+
+
+.
+
Since

0.2.1

+
+
+

+
+ +
+
+static inline RequestBuilder request()
+

Compose a pvRequest independently of a network operation.

+

This is not a network operation.

+

Use of request() is optional. pvRequests can be composed with individual network operation Builders.

+

Value pvReq = Context::request()
+                     .pvRequest("field(value)field(blah)")
+                     .record("pipeline", true)
+                     .build();
+
+
+

+
+ +
+
+ +
+

Get/Info

+

pvxs::client::Context::info() and pvxs::client::Context::get() return a +pvxs::client::GetBuilder to prepare either a get() or info() (GET_FIELD) +operation. The practical difference being that info() yields a Value +which will never have any fields marked.

+
+
+class GetBuilder : public pvxs::client::detail::CommonBuilder<GetBuilder, detail::CommonBase>
+

Prepare a remote GET or GET_FIELD (info) operation. See Context::get()

+
+

Public Functions

+
+
+inline GetBuilder &result(std::function<void(Result&&)> &&cb)
+

Callback through which result Value or an error will be delivered. The functor is stored in the Operation returned by exec().

+
+ +
+
+inline std::shared_ptr<Operation> exec()
+

Execute the network operation. The caller must keep returned Operation pointer until completion or the operation will be implicitly canceled.

+
+ +
+
+ +
+
+

Put

+

pvxs::client::Context::put() returns a +pvxs::client::PutBuilder to prepare a put() operation. +In the generic form of put(), the field values to sent have +to be passed to the builder callback. +This is necessary as the server mandated PV type definition +is not known when a Put operation is initiated.

+

Additionally, a put operation will by default first fetch the +present value of the PV and provide it to the builder callback. +This allows eg. to perform string to index lookup when writing +to an NTEnum.

+
+
+class PutBuilder : public pvxs::client::detail::CommonBuilder<PutBuilder, detail::PRBase>
+

Prepare a remote PUT operation See Context::put()

+
+

Public Functions

+
+
+inline PutBuilder &fetchPresent(bool f)
+

If fetchPresent is true (the default). Then the Value passed to the build() callback will be initialized with a previous value for this PV.

+

This will be necessary for situation like NTEnum to fetch the choices list. But may be undesirable when writing to array fields to avoid the expense of fetching a copy of the array to be overwritten.

+
+ +
+
+template<typename T>
inline PutBuilder &set(const std::string &name, const T &val, bool required = true)
+

Utilize default .build() to assign a value to the named field.

+
+
Parameters:
+
    +

  • name – The field name to attempt to assign.

    • +

  • val – The value to assign. cf. Value::from()

    • +

  • required – Whether to fail if this value can not be assigned to this field.

    • +
+
+
+
+ +
+
+inline PutBuilder &build(std::function<Value(Value&&)> &&cb)
+

Provide the builder callback.

+

Once the PV type information is received from the server, this function will be responsible for populating a Value which will actually be sent.

+

The functor is stored in the Operation returned by exec().

+
+ +
+
+inline PutBuilder &result(std::function<void(Result&&)> &&cb)
+

Provide the operation result callback. This callback will be passed a Result which is either an empty Value (success) or an exception on error.

+

The functor is stored in the Operation returned by exec().

+
+ +
+
+std::shared_ptr<Operation> exec()
+

Execute the network operation. The caller must keep returned Operation pointer until completion or the operation will be implicitly canceled.

+
+ +
+
+ +
+
+

RPC

+

pvxs::client::Context::rpc() returns a +pvxs::client::RPCBuilder to prepare an rpc() operation. +There are two ways to prepare the arguments of an RPC operation.

+

The recommended way is to use the one argument form of rpc() +and zero or more calls to pvxs::client::RPCBuilder::arg() +to set argument names and values. +These will be combined into a single argument structure +conforming to the pvxs::nt::NTURI convention.

+

Alternately, the two argument form of rpc() accepts are +arbitrary Value which is passed to the server unaltered.

+
+
+class RPCBuilder : public pvxs::client::detail::CommonBuilder<RPCBuilder, detail::PRBase>
+

Prepare a remote RPC operation. See Context::rpc()

+
+

Public Functions

+
+
+inline RPCBuilder &result(std::function<void(Result&&)> &&cb)
+

Callback through which result Value or an error will be delivered. The functor is stored in the Operation returned by exec().

+
+ +
+
+template<typename T>
inline RPCBuilder &arg(const std::string &name, const T &val)
+

Provide argument value.

+
+
Parameters:
+
    +

  • name – Argument name

    • +

  • val – The value to assign. cf. Value::from()

    • +
+
+
+
+ +
+
+std::shared_ptr<Operation> exec()
+

Execute the network operation. The caller must keep returned Operation pointer until completion or the operation will be implicitly canceled.

+
+ +
+
+ +
+
+

Operation and Result

+

The exec() method of the *Builder objects returns a shared_ptr +to an pvxs::client::Operation handle, which represents the +in-progress network operation. The caller must retain this +handle until completion, or the operation will be implicitly +cancelled.

+

When an Operation completes, a pvxs::client::Result is passed +to the result() callback. This object holds either a pvxs::Value +if the operation succeeded, or an exception.

+
+
+struct Operation
+

Handle for in-progress operation.

+
+

Public Types

+
+
+enum operation_t
+

Operation type.

+

Values:

+
+
+enumerator Info
+
+ +
+
+enumerator Get
+
+ +
+
+enumerator Put
+
+ +
+
+enumerator RPC
+
+ +
+
+enumerator Monitor
+
+ +
+
+enumerator Discover
+
+ +
+ +
+
+

Public Functions

+
+
+virtual const std::string &name() = 0
+

PV name.

+
+ +
+
+virtual bool cancel() = 0
+

Explicitly cancel a pending operation. Blocks until an in-progress callback has completed.

+
+
Returns:
+

true if the operation was canceled, or false if already complete.

+
+
+
+ +
+
+virtual Value wait(double timeout) = 0
+

Block until Operation completion.

+

As an alternative to a .result() callback, wait for operation completion, timeout, or interruption (via. interrupt() ).

+
+
Parameters:
+

timeout – Time to wait prior to throwing TimeoutError. cf. epicsEvent::wait(double)

+
+
Throws:
+
    +

  • Timeout – Timeout exceeded

    • +

  • Interrupted – interrupt() called

    • +
+
+
Returns:
+

result Value. Always empty/invalid for put()

+
+
+
+ +
+
+inline Value wait()
+

wait(double) without a timeout

+
+ +
+
+virtual void interrupt() = 0
+

Queue an interruption of a wait() or wait(double) call.

+
+ +
+
+ +
+
+class Result
+

Holder for a Value or an exception.

+
+

Public Functions

+
+
+inline Value &operator()()
+

Access to the Value, or rethrow the exception.

+
+ +
+
+ +
+
+

Monitor

+

pvxs::client::Context::monitor() returns a +pvxs::client::MonitorBuilder to prepare a MONITOR operation. +The result of this preparation is a pvxs::client::Subscription +which represents the in-progress network operation. +The caller must retain this handle or the operation will be implicitly cancelled.

+

Until cancelled, a Subscription will attempt to (re)connect to the requested PV.

+

A Subscription object allows access to a queue of data updates as Value and events/errors as exceptions. +The pvxs::client::Subscription::pop() method will remove an entry from the queue, or return an empty/invalid Value. +Data updates are returned as a valid Value. +Events/errors are thrown as exceptions.

+

An pvxs::client::MonitorBuilder::event() callback is only invoked when the +Subscription queue becomes not-empty. +It will not be called again until pvxs::client::Subscription::pop() has returned +an empty/invliad Value.

+

The special exceptions pvxs::client::Connected, pvxs::client::Disconnect, and pvxs::client::Finished +have specific meaning when thrown by pvxs::client::Subscription::pop().

+
+
Connected

Depending on pvxs::client::MonitorBuilder::maskConnected() (default true). +Queued when a Subscription becomes connected. +The Connected object include the server host:port as well as a (client) time of connection.

+
+
Disconnect

Depending on pvxs::client::MonitorBuilder::maskDisconnected() (default false). +Queued when a Subscription becomes disconnected.

+
+
Finished

Depending on pvxs::client::MonitorBuilder::maskDisconnected() (default false). +Queued when the server indicates that Subscription will receive no more date updates as a normal completion. +Finished is a sub-class of Disconnect.

+
+
+

There are several aspects of a Subscription which may be selected through the MonitorBuilder. +The special pvxs::client::Connected and pvxs::client::Disconnect “errors” may appear in +the event queue

+
+
+class MonitorBuilder : public pvxs::client::detail::CommonBuilder<MonitorBuilder, detail::CommonBase>
+

Prepare a remote subscription See Context::monitor()

+
+

Public Functions

+
+
+inline MonitorBuilder &event(std::function<void(Subscription&)> &&cb)
+

Install FIFO not-empty event callback.

+

This functor will be called each time the Subscription event queue becomes not empty. A Subscription becomes empty when Subscription::pop() returns an empty/invalid Value.

+

The functor is stored in the Subscription returned by exec().

+
+ +
+
+inline MonitorBuilder &maskConnected(bool m = true)
+

Include Connected exceptions in queue (default false).

+
+ +
+
+inline MonitorBuilder &maskDisconnected(bool m = true)
+

Include Disconnected exceptions in queue (default true).

+
+ +
+
+std::shared_ptr<Subscription> exec()
+

Submit request to subscribe.

+
+ +
+
+ +
+
+struct Subscription
+

Handle for monitor subscription.

+
+

Public Functions

+
+
+inline const std::string &name()
+

PV name.

+
+ +
+
+virtual bool cancel() = 0
+

Explicitly cancel a active subscription. Blocks until any in-progress callback has completed.

+
+ +
+
+virtual void pause(bool p = true) = 0
+

Ask a server to stop (true) or re-start (false), sending updates to this Subscription.

+
+ +
+
+inline void resume()
+

Shorthand for.

+

pause(false) 
+
+
+

+
+ +
+
+virtual Value pop() = 0
+

De-queue update from subscription event queue.

+

If the queue is empty, return an empty/invalid Value (Value::valid()==false). A data update is returned as a Value. An error or special event is thrown.

+

std::shared_ptr<Subscription> sub(...);
+try {
+    while(auto update = sub.pop()) {
+        // have data update
+        ...
+    }
+    // queue empty
+} catch(Connected& con) {   // if MonitorBuilder::maskConnected(false)
+} catch(Finished& con) {    // if MonitorBuilder::maskDisconnected(false)
+} catch(Disconnect& con) {  // if MonitorBuilder::maskDisconnected(false)
+} catch(RemoteError& con) { // error message from server
+} catch(std::exception& con) { // client side error
+}
+
+
+

+
+
Throws:
+
+
+
Returns:
+

A valid Value until the queue is empty

+
+
+
+ +
+
+virtual void stats(SubscriptionStat&, bool reset = false) = 0
+

Poll statistics

+
Since

1.1.0

+
+
+

+
+ +
+
+virtual std::shared_ptr<Subscription> shared_from_this() const = 0
+

Return strong internal reference which will not prevent implicit cancellation when the last reference returned by exec() is released.

+
Since

0.2.0

+
+
+

+
+ +
+
+ +
+
+

Connect

+

Request that a Channel be created now which may be used by other Operations, +allowing them to complete more quickly.

+
+
+class ConnectBuilder
+

cf. Context::connect()

+
Since

0.2.0

+
+
+

+
+

Public Functions

+
+
+inline ConnectBuilder &onConnect(std::function<void()> &&cb)
+

Handler to be invoked when channel becomes connected.

+
+ +
+
+inline ConnectBuilder &onDisconnect(std::function<void()> &&cb)
+

Handler to be invoked when channel becomes disconnected.

+
+ +
+
+inline ConnectBuilder &syncCancel(bool b)
+

Controls whether Connect::~Connect() synchronizes.

+

When true (the default) explicit or implicit cancel blocks until any in progress callback has completed. This makes safe some use of references in callbacks.

+
Since

0.2.0

+
+
+

+
+ +
+
+std::shared_ptr<Connect> exec()
+

Submit request to connect.

+
+ +
+
+ +
+
+struct Connect
+

Handle for entry in Channel cache.

+
+

Public Functions

+
+
+virtual const std::string &name() const = 0
+

Name passed to Context::connect()

+
+ +
+
+virtual bool connected() const = 0
+

Poll (momentary) connection status.

+
+ +
+
+ +
+
+

Threading

+

A client Context will invoke user callback functions from one or more internal worker threads. +However, it is guaranteed that callbacks relating to a given Channel (PV name + priority) will never be executed concurrently. +This implies that callbacks for a single operation will also never be executed concurrently.

+

User code must avoid doing unnecessary work from within a callback function as this will +prevent other callbacks from be executed.

+
+
+

Ownership

+

User provided callbacks are in the form of std::function which may, +directly or indirectly, store shared_ptr<> instances. +The returned Operation and Subscription instances should be treated as +storing the std::function instance(s) and thus any shared_ptr<> captured in them.

+

Therefore, in order to avoid a resource leak, +it is advisable to consider whether a returned Operation or Subscription +may participate in a reference loop.

+

For example, the following creates a reference loop between the Operation instance and the “mystruct” instance.

+
struct mystruct {
+    std::shared_ptr<Operation> op; // <-- Danger!
+};
+auto myptr = std::make_shared<mystruct>();
+
+Context ctxt(...);
+myptr->op = ctxt.get("pv:name")
+                .result([myptr](Result&& result) { // <-- Danger!
+                })
+                .exec();
+
+
+

While such loops can be explicitly broken (eg. by NULLing ‘myptr->op’) it is strongly +recommended to avoid such situations as unexpected (exceptional) conditions can easily +lead to resource leaks which are quite difficult to detect and isolate.

+

Where possible it is recommended to capture weak_ptr<> instances.

+
+
+
+

pvRequest

+

All operations except info() (GET_FIELD) take a Value which servers may use to modify or qualify the operation. +Conventionally, the two ways this may be done is to provide a mask to limit the (sub)fields for which data is returned. +Secondly, to provide certain well-known options to modify the operation.

+

The pvRequest conditions may be specified in three ways through the methods of pvxs::client::detail::CommonBuilder +exposed through the individual *Builder types.

+
+
Programmatic

The field() and record() methods.

+
+
Textual

The pvRequest() method accepts a string which is parsed into calls to the field() and record() methods. +These two approaches may be intermixed.

+
+
Fallback

The rawRequest() method accepts an externally assembled Value which is sent without modification.

+
+
+
+
+template<typename SubBuilder, typename Base>
class CommonBuilder : public Base
+

Options common to all operations.

+
+

Public Functions

+
+
+inline SubBuilder &field(const std::string &fld)
+

Add field to pvRequest blob. A more efficient alternative to 

pvRequest("field(name)") 
+
+
+

+
+ +
+
+template<typename T>
inline SubBuilder &record(const std::string &name, const T &val)
+

Add a key/value option to the request.

+

Well known options include:

+

    +

  • queueSize : positive integer

    • +

  • block : bool

    • +

  • process : bool or string “true”, “false”, or “passive”

    • +

  • pipeline : bool

    • +
+

+

A more efficient alternative to 

pvRequest("record[key=value]") 
+
+
+

+
+ +
+
+inline SubBuilder &pvRequest(const std::string &expr)
+

Parse pvRequest string.

+

Supported syntax is a list of zero or more entities separated by zero or more spaces.

+

    +

  • field(<fld.name>)

    • +

  • record[<key>=\<value>]

    • +
+

+
+ +
+
+inline SubBuilder &rawRequest(const Value &r)
+

Store raw pvRequest blob.

+
+ +
+
+inline SubBuilder &syncCancel(bool b)
+

Controls whether Operation::cancel() and Subscription::cancel() synchronize.

+

When true (the default) explicit or implicit cancel blocks until any in progress callback has completed. This makes safe some use of references in callbacks.

+
Since

0.2.0

+
+
+

+
+ +
+
+ +
+

Syntax

+

The parser behind pvxs::client::detail::CommonBuilder::pvRequest() understands the following grammar.

+
+pvRequest   ::=  | entry | pvRequest entry
+entry       ::=  field | record | field_name
+field       ::=  "field" "(" field_list ")"
+record      ::=  "record" "[" option_list "]"
+field_list  ::=  | field_name | field_list "," field_name
+option_list ::=  | option | option_list option
+option      ::=  key "=" value
+
+

For examples:

+
    +

  • “field()”

    • +

  • “field(value)”

    • +

  • “value”

    • +

  • “field(value,alarm)”

    • +

  • “field(value)field(alarm)”

    • +

  • “record[wait=true]”

    • +

  • “field()record[wait=true]”

    • +

  • “field(value)record[wait=true]”

    • +
+
+
+
+

Misc

+
+
+struct Config
+
+

Public Functions

+
+
+Config &applyEnv()
+

update using defined EPICS_PVA* environment variables

+
+ +
+
+Config &applyDefs(const defs_t &defs)
+

update with definitions as with EPICS_PVA* environment variables Process environment is not changed.

+
+ +
+
+void updateDefs(defs_t &defs) const
+

extract definitions with environment variable names as keys. Process environment is not changed.

+
+ +
+
+void expand()
+

Apply rules to translate current requested configuration into one which can actually be loaded based on current host network configuration.

+

Explicit use of expand() is optional as the Context ctor expands any Config given. expand() is provided as a aid to help understand how Context::effective() is arrived at.

+
+
Post:
+

autoAddrList==false

+
+
+
+ +
+
+inline Context build() const
+

Create a new client Context using the current configuration.

+
+ +
+
+

Public Members

+
+
+std::vector<std::string> addressList
+

List of unicast, multicast, and broadcast addresses to which search requests will be sent.

+

Entries may take the forms:

    +

  • <ipaddr>[:<port#>]

    • +

  • <ipmultiaddr>[:<port>][,<ttl>][@<ifaceaddr>]

    • +
+

+
+ +
+
+std::vector<std::string> interfaces
+

List of local interface addresses on which beacons may be received. Also constrains autoAddrList to only consider broadcast addresses of listed interfaces. Empty implies wildcard 0.0.0.0

+
+ +
+
+std::vector<std::string> nameServers
+

List of TCP name servers. Client context will maintain connections, and send search requests, to these servers.

+
Since

0.2.0

+
+
+

+
+ +
+
+unsigned short udp_port = 5076
+

UDP port to bind. Default is 5076. May be zero, cf. Server::config() to find allocated port.

+
+ +
+
+unsigned short tcp_port = 5075
+

Default TCP port for name servers

+
Since

0.2.0

+
+
+

+
+ +
+
+bool autoAddrList = true
+

Whether to extend the addressList with local interface broadcast addresses. (recommended)

+
+ +
+
+double tcpTimeout = 40.0
+

Inactivity timeout interval for TCP connections. (seconds)

+
Since

0.2.0

+
+
+

+
+ +
+
+

Public Static Functions

+
+
+static inline Config fromEnv()
+

Default configuration using process environment.

+
+ +
+
+ +
+
+struct Connected : public std::runtime_error
+

For monitor only. Subscription has (re)connected.

+
+ +
+
+struct Disconnect : public std::runtime_error
+

Operation failed because of connection to server was lost.

+

Subclassed by pvxs::client::Finished

+
+

Public Members

+
+
+const epicsTime time
+

When loss of connection was noticed (when timeout expires).

+
+ +
+
+ +
+
+struct Finished : public pvxs::client::Disconnect
+

For monitor only. Subscription has completed normally and no more events will ever be received.

+
+ +
+
+struct RemoteError : public std::runtime_error
+

Error condition signaled by server.

+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/details.html b/details.html new file mode 100644 index 000000000..6c9e674ea --- /dev/null +++ b/details.html @@ -0,0 +1,308 @@ + + + + + + + + + Details — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Details

+
+

Reporting a Bug

+

Before reporting a bug, please check to see if this issue has already been reported.

+

When composing a new report, please run the included automatic tests “make runtests” and mention the results. +It is enough to mention “All tests successful.” if this is so. (see runtests)

+

Bug reports should always include:

+
    +

  • EPICS Base version or VCS commit

    • +

  • PVXS module version or VCS commit

    • +

  • libevent version or VCS commit (running “pvxget -V” shows these)

    • +

  • EPICS host and target archs. (eg. “linux-x86_64”)

    • +

  • Host OS name and version (eg. run “cat /etc/issue”)

    • +

  • Compiler name and version (eg. run “gcc –version”)

    • +

  • The values of any $EPICS_PVA* environment variables which are set.

    • +

  • Any local/site modifications to PVXS or libevent

    • +

  • Concise instructions for reproducing the issue.

    • +
+

Additional information which may be relevant:

+
    +

  • Number of network interfaces if more than one.

    • +

  • Whether clients and/or servers are on the same host or different hosts.

    • +

  • Whether clients and/or servers are in the same subnet or different subnets

    • +

  • Whether network traffic crosses between virtual machine(s) and physical host(s).

    • +

  • Firewall rules on UDP traffic to/from port 5075 or TCP connections to port 5074

    • +

  • Any local/site modifications to EPICS Base

    • +
+

If the module has built successfully, then running pvxinfo -D will +report much of this information.

+
+

Packet Capture

+

Some kinds of issues can be easily reproduced by the reporter, but not by others. +eg. those related to interoperability, site private applications, or “environmental” conditions. +In these cases it may be necessary to capture the troublesome network traffic to file. +This section provides a quick guide for using Wireshark to do this.

+

An important concern when providing a packet capture taken on a private network is to +avoid unintentionally capturing unrelated, and potentially sensitive, traffic.

+

Usage of the pva.lua extension found in cashark +provides a quick way to filter out non-PVA traffic.

+
wireshark -X lua_script:pva.lua
+
+
+

While Wireshark is running, apply a display filter of pva to show only PV Access protocol traffic. +From the File menu, select Export Specified Packets, then choose to export only displayed packets. +Please also check Compress with gzip.

+

If it is necessary to select only a specific PVA exchange, use the +Follow TCP Stream +feature to display/export only packets associated with a single TCP connection. +This will result in a display filter expression like tcp.stream eq 1. +When trying to identify a single connection/stream, it may be helpful to apply a filter like pva.pv=="special:pv:name".

+

If if isn’t convenient to run the full Wireshark GUI when capturing, +the tshark CLI utility may be used to capture raw traffic to file. +Display filters like pva.lua may not be used during capture, +so it will be necessary to filter again using the GUI on another host to produce a second (cooked) capture file.

+
tshark -i any -f '!port ssh' -w raw.pcapng
+gzip raw.pcapng
+# copy raw.pcapng.gz to another host
+wireshark -X lua_script:pva.lua raw.pcapng.gz
+
+
+

If is doubt about whether private information has been successfully excluded, +packet capture files may be sent privately to the author by email instead of uploading to github. +The author’s PGP key may be found below.

+

Please compress all capture files uploaded or sent!

+
+
+
+

Release Policy

+

PVXS Release numbering follows the Semantic Versioning +scheme of MAJOR.MINOR.PATCH with the following amendments.

+
    +

  • A change to the MAJOR number indicates that a backwards incompatible change to some part of the public API. +This may not effect every user application. +This policy is intended to provide users with confidence in upgrading when MAJOR does not change.

    • +

  • The PATCH number will only be incremented if changes to the public API are believed to maintain ABI compatibility. +MINOR will be incremented when a known ABI incompatible change is made. +Library SONAMES take the form MAJOR.MINOR.

    • +

  • Backwards incompatible changes to semi-public Expert APIs may appear in a MINOR release.

    • +

  • At this time only one version number is maintained, which is applied to both +the main libpvxs.so and the auxiliary libpvxsIoc.so. +Statements about API or ABI compatibility apply to both libraries as a group.

    • +

  • See Forward Compatibility for NT* type construction helpers.

    • +
+

Each release will be accompanied by a signed tag in the git repository, +which may be verified with the author’s GPG key +5C159E669D69E2D4C4E74E540C8E1C8347330CFB +(alternate) +.

+
+
+

Expert APIs

+

The Expert API are a set of semi-public definitions and methods which are not intended for general use, +and may be subject to incompatible change in a minor release. +Expert API calls are wrapped by “#ifdef PVXS_EXPERT_API_ENABLED” +to prevent unintentional usage.

+

If a change is considered, +best effort will be made to involve developers/sites known to make use of Expert API. +Prospective users of the Expert API are encouraged to contact the author.

+

Elements of the Expert API may be “promoted” to regular/full API status if warranted.

+
+
+

Contributing

+

The recommended path for including changes is through Pull Request.

+

When changing c++ code please do:

+
    +

  • Indent with 4 spaces. No hard tabs. UNIX style EoL.

    • +

  • Try to maintain the style of surrounding code.

    • +

  • Include meaningful code comments where reasonable.

    • +

  • Add doxygen tags @since UNRELEASED when documenting additions/changes to public APIs.

    • +
+

but do not:

+
    +

  • Add any c++ global constructors or destructors in the pvxs library. (Ok in tools, examples, or tests)

    • +
+

When committing changes please do:

+
    +

  • Include a commit message

    • +

  • Break up changes into multiple commits where reasonable

    • +

  • Include whitespace only changes as separate commits

    • +
+
+

Contributors

+

Who did the [work](https://github.com/epics-base/pvxs/graphs/contributors) to make PVXS what it is.

+
    +

  • Alexander Wells

    • +

  • Basil Aljamal

    • +

  • Bruno Martins

    • +

  • Érico Nogueira

    • +

  • George McIntyre

    • +

  • Henrique Silva

    • +

  • karlosp

    • +

  • Klemen Vodopivec

    • +

  • Michael Davidsaver

    • +

  • Peter Milne

    • +

  • Simon Rose

    • +

  • Thomas Ives

    • +
+

Those who supported this work.

+ +
+
+
+

Implementation Notes

+

Misc. notes on design and Implementation.

+
    +

  • All Server and client Context instances listening on the same UDP port# within a process +will share a single UDP socket.

    • +

  • The UDP local multicast fanout aspect of the PVA protocol is not implemented.

    • +

  • Client UDP search retry follows a linear backoff starting from 1 second +and stepping to 30 seconds. cf. bucketInterval and nBuckets in client.cpp.

    • +

  • To level UDP search traffic, search retry may delay a PV for an extra +bucket if the difference in the number of PVs in the desired and subsequent +buckets is too large.

    • +

  • Client Context::hurryUp() expires the search bucket timer immediately, +saving up to bucketInterval seconds.

    • +

  • Each Value refers points to a pair of FieldDesc and FieldStorage in arrays +of the same. Value::operator[] steps around in these arrays.

    • +

  • There is a hidden StructTop which holds the FieldStorage array and holds +a shared_ptr to the FieldDesc array to join ownership of the two.

    • +

  • TCP connection buffering will read up to tcp_readahead (cf. conn.h) bytes +while waiting for a complete header. After a header is received, +the larger of tcp_readahead or the message body length is buffered.

    • +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/example.html b/example.html new file mode 100644 index 000000000..00ba7a5e8 --- /dev/null +++ b/example.html @@ -0,0 +1,446 @@ + + + + + + + + + Examples — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Examples

+

Example are built, but not installed. +They can be found under example/O.*

+

Latest versions https://github.com/epics-base/pvxs/blob/master/example/

+
+

Shortest Client Get

+
/**
+ * Copyright - See the COPYRIGHT that is included with this distribution.
+ * pvxs is distributed subject to a Software License Agreement found
+ * in file LICENSE that is included with this distribution.
+ */
+/** The short example of a client GET operation.
+ */
+
+#include <iostream>
+
+#include <pvxs/client.h>
+#include <pvxs/log.h>
+
+int main(int argc, char* argv[]) {
+    using namespace pvxs;
+
+    // (Optional) configuring logging using $PVXS_LOG
+    logger_config_env();
+
+    // Configure client using $EPICS_PVA_*
+    auto ctxt(client::Context::fromEnv());
+
+    // fetch PV "some:pv:name" and wait up to 5 seconds for a reply.
+    // (throws an exception on error, including timeout)
+    Value reply = ctxt.get("some:pv:name").exec()->wait(5.0);
+
+    // Reply is printed to stdout.
+    std::cout<<reply;
+
+    return 0;
+}
+
+
+
+
+

Shortest Server

+
/**
+ * Copyright - See the COPYRIGHT that is included with this distribution.
+ * pvxs is distributed subject to a Software License Agreement found
+ * in file LICENSE that is included with this distribution.
+ */
+/** The short example of a server.
+ */
+
+#include <iostream>
+
+#include <pvxs/server.h>
+#include <pvxs/sharedpv.h>
+#include <pvxs/nt.h>
+#include <pvxs/log.h>
+
+int main(int argc, char* argv[]) {
+    using namespace pvxs;
+
+    // (Optional) configuring logging using $PVXS_LOG
+    logger_config_env();
+
+    // Use pre-defined NTScalar structure w/ double for primary value field.
+    Value initial = nt::NTScalar{TypeCode::Float64}.create();
+    initial["value"] = 42.0;
+
+    // Storage and access for network visible Process Variable
+    server::SharedPV pv(server::SharedPV::buildMailbox());
+    pv.open(initial);
+
+    server::Server::fromEnv()        // Configure a server using $EPICS_PVAS_* or $EPICS_PVA_*
+            .addPV("my:pv:name", pv) // add (and name) one local PV
+            .run();                  // run until SIGINT
+
+    return 0;
+}
+
+
+
+
+

Client Demo

+
/**
+ * Copyright - See the COPYRIGHT that is included with this distribution.
+ * pvxs is distributed subject to a Software License Agreement found
+ * in file LICENSE that is included with this distribution.
+ */
+/** Meant to be run against the mailbox example.
+ *  eg. in one terminal run:
+ *
+ *   ./mailbox some:pv:name
+ *
+ * And in another terminal run:
+ *
+ *   ./client some:pv:name
+ */
+
+#include <iostream>
+
+#include <pvxs/client.h>
+#include <pvxs/log.h>
+
+using namespace pvxs;
+
+int main(int argc, char* argv[])
+{
+    if(argc<2) {
+        std::cerr<<"Usage: "<<argv[0]<<" <pvname>\n";
+        return 1;
+    }
+
+    // Read $PVXS_LOG from process environment and update
+    // logging configuration.  eg.
+    //    export PVXS_LOG=*=DEBUG
+    // makes a lot of noise.
+    logger_config_env();
+
+    // Create a client context
+    auto ctxt(client::Context::fromEnv());
+
+    // Fetch current value
+    int32_t current;
+    {
+        std::cout<<"Getting current value of '"<<argv[1]<<"'"<<std::endl;
+        // Build and start network operation
+        auto op = ctxt.get(argv[1])
+                .exec();
+
+        // wait for it to complete, for up to 5 seconds.
+        Value result = op->wait(5.0);
+
+        std::cout<<"Result is:\n"<<result<<std::endl;
+
+        if(auto value = result["value"]) {
+            // there is a .value field
+            // as may still throw pvxs::NoConvert if its value can't
+            // be converted to int32_t
+            current = value.as<int32_t>();
+        } else {
+            // an example.  won't happen with mailbox server
+            std::cerr<<"Server type doesn't have .value field!\n";
+            return 1;
+        }
+    }
+
+    {
+        // attempt to change.
+        // uses simple builder form to assign .value
+
+        ctxt.put(argv[1])
+                .set("value", current+1)
+                .exec()
+                ->wait(5.0);
+
+        std::cout<<"First increment successful"<<std::endl;
+    }
+
+    {
+        // change again.
+        // use build() callback
+
+        auto op = ctxt.put(argv[1])
+                // provide present value to build() callback.
+                .fetchPresent(true)
+                .build([](Value&& current) -> Value {
+                    // allocate an empty container
+                    auto toput(current.cloneEmpty());
+
+                    // fill in .value.
+                    // Assignment implicitly marks .value as changed
+                    toput["value"] = current["value"].as<int32_t>() + 1;
+
+                    // return the container to be sent
+                    return toput;
+                })
+                .exec();
+
+        op->wait(5.0);
+
+        std::cout<<"Second increment successful"<<std::endl;
+    }
+
+    // fetch final value
+    {
+        std::cout<<"Getting current value of '"<<argv[1]<<"'"<<std::endl;
+        // Build and start network operation
+        auto result = ctxt.get(argv[1])
+                .exec()
+                ->wait(5.0);
+
+        std::cout<<"Result is:\n"<<result<<std::endl;
+    }
+
+    return 0;
+}
+
+
+
+
+

Mailbox Server

+
/**
+ * Copyright - See the COPYRIGHT that is included with this distribution.
+ * pvxs is distributed subject to a Software License Agreement found
+ * in file LICENSE that is included with this distribution.
+ */
+/**
+ * Serves a single PV name.
+ * Any updates written (PUT) to this PV will be stored verbatim
+ * and sent to any subscribers.
+ */
+
+#include <iostream>
+
+#include <epicsTime.h>
+
+#include <pvxs/sharedpv.h>
+#include <pvxs/server.h>
+#include <pvxs/nt.h>
+#include <pvxs/log.h>
+
+using namespace pvxs;
+
+int main(int argc, char* argv[])
+{
+    if(argc<=1) {
+        std::cerr<<"Usage: "<<argv[0]<<" <pvname> [pvname1 [...]]\n";
+        return 1;
+    }
+
+    // Read $PVXS_LOG from process environment and update
+    // logging configuration.  eg.
+    //    export PVXS_LOG=*=DEBUG
+    // makes a lot of noise.
+    logger_config_env();
+
+    // Must provide a data type for the mailbox.
+    // Use pre-canned definition of scalar with meta-data
+    Value initial = nt::NTScalar{TypeCode::Float64}.create();
+
+    // (optional) Provide an initial value
+    initial["value"] = 42.0;
+    initial["alarm.severity"] = 0;
+    initial["alarm.status"] = 0;
+    initial["alarm.message"] = "";
+
+    std::vector<server::SharedPV> pvs(argc-1u);
+
+    for(size_t i=0ul; i<pvs.size(); i++) {
+        // Actually creating a mailbox PV.
+        // buildMailbox() installs a default onPut() handler which
+        // stores whatever a client sends (subject to our data type).
+        server::SharedPV pv(server::SharedPV::buildMailbox());
+
+        // (optional) Replace the default PUT handler to do a range check
+        pv.onPut([](server::SharedPV& pv,
+                 std::unique_ptr<server::ExecOp>&& op,
+                 Value&& top)
+         {
+
+             // (optional) arbitrarily clip value to [-100.0, 100.0]
+             double val(top["value"].as<double>());
+             if(val<-100.0)
+                 top["value"] = -100.0;
+             else if(val>100.0)
+                 top["value"] = 100.0;
+
+             // (optional) Provide a timestamp if the client has not (common)
+             Value ts(top["timeStamp"]);
+             if(!ts.isMarked(true, true)) {
+                 // use current time
+                 epicsTimeStamp now;
+                 if(!epicsTimeGetCurrent(&now)) {
+                     ts["secondsPastEpoch"] = now.secPastEpoch + POSIX_TIME_AT_EPICS_EPOCH;
+                     ts["nanoseconds"] = now.nsec;
+                 }
+             }
+
+             // (optional) update the SharedPV cache and send
+             // a update to any subscribers
+             pv.post(top);
+
+             // Required.  Inform client that PUT operation is complete.
+             op->reply();
+         });
+
+        // Associate a data type (and maybe initial value) with this PV
+        pv.open(initial);
+
+        pvs[i] = std::move(pv);
+    }
+
+    // Build server which will serve this PV
+    // Configure using process environment.
+    auto serv(server::Server::fromEnv());
+
+    for(size_t i=0ul; i<pvs.size(); i++) {
+        serv.addPV(argv[i+1], pvs[i]);
+    }
+
+    // (optional) Print the configuration this server is using
+    // with any auto-address list expanded.
+    std::cout<<"Effective config\n"<<serv.config();
+
+    std::cout<<"Running\n";
+
+    // Start server and run forever, or until Ctrl+c is pressed.
+    // Returns on SIGINT or SIGTERM
+    serv.run();
+
+    std::cout<<"Done\n";
+
+    return 0;
+}
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 000000000..49f8dc438 --- /dev/null +++ b/genindex.html @@ -0,0 +1,1007 @@ + + + + + + + + Index — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ D + | L + | P + | T + | V + +
+

D

+ + + +
+ +

L

+ + + +
+ +

P

+ + + +
+ +

T

+ + + +
+ +

V

+ + +
+ + + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + +
+ + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..3870f6708 --- /dev/null +++ b/index.html @@ -0,0 +1,341 @@ + + + + + + + + + PVXS client/server for PVA Protocol — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

PVXS client/server for PVA Protocol

+

This module provides a library (libpvxs.so or pvxs.dll) and a set of +CLI utilities acting as PVAccess protocol client and/or server.

+

PVXS is functionally equivalent to the +pvDataCPP and +pvAccessCPP modules, +which it hopes to eventually supplant (Ok, the author hopes).

+ +

Dependencies

+
    +

  • A C++11 compliant compiler

    • +
+
+
    +

  • GCC >= 4.8

    • +

  • Visual Studio >= 2015 / 12.0’

    • +

  • clang

    • +
+
+
    +

  • EPICS Base >=3.15.1

    • +

  • libevent >=2.0.1 (Optionally bundled)

    • +

  • (optional) CMake >=3.1, only needed when building bundled libevent

    • +
+

See Building from Source for details.

+
+

Download

+

Releases are published to https://github.com/epics-base/pvxs/releases. +See Release Policy for details.

+
+

Contents:

+ +
+
+
+
+

Indices and tables

+ +
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/ioc.html b/ioc.html new file mode 100644 index 000000000..485c2fb47 --- /dev/null +++ b/ioc.html @@ -0,0 +1,355 @@ + + + + + + + + + IOC Integration — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

IOC Integration

+
#include <pvxs/iochooks.h>
+namespace pvxs { namespace namespace ioc { ... } }
+
+
+

The separate pvxsIoc library exists to run a PVXS server as part of an IOC. +See also Including PVXS in your application.

+

IOC Integration respects the $PVXS_LOG as well as the $EPICS_PVA* environment variables. +Changes to this environment variable are possible prior to +calling *_registerRecordDeviceDriver(pdbbase).

+
+

IOC shell

+

The pvxsIoc library adds several IOC shell functions which apply to all PVs +served by the Integrated PVA server.

+
+
+void pvxsr(int level)
+

PVXS Server Report. Shows information about server configuration (level==0) +or about connected clients (level>0). Indirectly calls pvxs::server::Source::show().

+
+ +
+
+void pvxsl(int level)
+

PVXS Server List. Lists attached Sources and PV names. +Indirectly calls pvxs::server::Source::onList().

+
+ +
+
+void pvxsi()
+

Print information about module versions, target, and toolchain. +May be requested when reporting a bug.

+
+ +
+
+

Adding custom PVs to Server

+
+
+server::Server pvxs::ioc::server()
+

Return the singleton Server instance which is setup for use in an IOC process.

+

This Server instance is created during a registrar function, started by the initHookAfterCaServerRunning phase of iocInit(). It is stopped and destroyed during an epicsAtExit() hook added during an initHookAfterInitDatabase hook..

+

Any configuration changes via. epicsEnvSet() must be made before registrars are run by *_registerRecordDeviceDriver(pdbbase).

+

server::SharedPV and server::Source added before iocInit() will be available immediately. Others may be added (or removed) later.

+

static void myinitHook(initHookState state) {
+    if(state!=initHookAfterIocBuilt)
+        return;
+
+    server::SharedPV mypv(...);
+    ioc::server()
+          .addPV("my:pv:name", mypv);
+}
+static void myregistrar() {
+    initHookRegister(&myinitHook);
+}
+extern "C" {
+     // needs matching "registrar(myregistrar)" in .dbd
+    epicsExportRegistrar(myregistrar);
+}
+
+
+

+
+
Throws:
+

std::logic_error – if called before instance is created, or after instance is destroyed.

+
+
+
+ +
+
+
+

QSRV 2

+

Beginning with PVXS 1.2.0 the functionality of QSRV +is replicated in the pvxsIoc library. +As of 1.3.0 this feature preview is considered beta level with equivalent functionality.

+

It is recommended not to load both pvxsIoc.dbd and qsrv.dbd in the same IOC process. +However, if this is done. Users may opt out at runtime by setting +$PVXS_QSRV_ENABLE=NO before iocInit().

+
# Default with PVXS >= 1.3.0
+# Needed with PVXS 1.2.x
+epicsEnvSet("PVXS_QSRV_ENABLE", "YES")
+iocInit()
+
+
+

The features of QSRV are divided into three broad categories.

+
    +

  • Single PV access

    • +

  • Group PV access

    • +

  • PVA Links

    • +
+
+

IOC Shell

+

IOC Shell commands specific to database integration.

+
+
+void pvxgl(int level, const char *pattern)
+

Group PV information. At detail level 0, lists Group names. +Pattern restricts listing to only matching names.

+
+ +
+
+void dbLoadGroup(const char *file, const char *macros)
+

Load Group definitions from a separate JSON file. +(as opposed to info(Q:group, {...}) in a .db file) +See JSON Reference.

+
+ +
+
+

Single PV

+

When QSRV is enabled, access to individual/single PVs in the global process database +is automatic and equivalent to the access provided by the Channel Access server +in the IOC (aka. RSRV).

+

So caget pv:name and pvxget pv:name should be functionally equivalent.

+

Beginning with 1.2.3, long string detection is automatic in some cases. +eg. .NAME and .INP. +In some situations adding a $ suffix is still necessary when addressing +a DBF_STRING or DBF_*LINK field to make it visible as a PVA string. +It will not be necessary for clients to interpret a char[] as a “long string”.

+
# eg.
+pvget some:record.NAME$
+pvget some:record.INP$
+
+
+

An info(Q:form, "...") may be used to set the display.form PVA meta-data hint +which is used by some OPI clients.

+
record(longin, "my:bits") {
+    field(VAL, "0x1234")
+    info(Q:form, "Hex") # hint to clients to render as hexadecimal
+}
+
+
+

or:

+
record(waveform, "my:long:string") {
+    field(FTVL, "CHAR")
+    field(NELM, "1024")
+    info(Q:form, "String") # hint to QSRV to expose char[] as string
+}
+
+
+

Currently supported format hints are:

+
    +

  • Default

    • +

  • String

    • +

  • Binary

    • +

  • Decimal

    • +

  • Hex

    • +

  • Exponential

    • +

  • Engineering

    • +
+
+
+

Group PV

+
+

Contents:

+ +
+
+
+

Access Security

+

QSRV will enforce an optional access control policy file (.acf) loaded by asSetFilename(). +This policy is applied to Single PVs just as RSRV does for Channel Access. +With Group PVs, restrictions are not defined for the group, but rather for the individual member records. +The same policy applies whether record is accessed individually, or through a group.

+

Policy application differs from CA (RSRV) in several ways:

+

Client hostname is always the numeric IP address. +HAG() entries must either contained numeric IP addresses, +or that asCheckClientIP=1 flag must be set to translate hostnames into IPs on ACF file load (effects CA server as well). +This prevents clients from trivially forging “hostname”. +In additional to client usernames UAG() definitions may contained items beginning with role/ which are matched against the list of local systems groups of which the client username is a member. +Username to group lookup is done locally by QSRV, and depends on IOC host authentication configuration. +Note that this is still based on the client provided username string.

+
UAG(special) {
+    someone, "role/op"
+}
+
+
+

The “special” UAG() will match CA or PVA clients with the username “someone”. +It will also match a PVA client if the “special” account exists locally, +and is a member of the “op” group (supported on POSIX targets and Windows).

+
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/netconfig.html b/netconfig.html new file mode 100644 index 000000000..0414825b1 --- /dev/null +++ b/netconfig.html @@ -0,0 +1,250 @@ + + + + + + + + + PVA Network Configuration — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

PVA Network Configuration

+
+

Big Picture

+

A PV Access network protocol operation proceeds in two phases: +PV name resolution, and data transfer. +Name resolution is the process is determining which PVA server claims to provide each PV name. +Once this is known, a TCP connection is open to that server, and the operation(s) are executed.

+

The PVA Name resolution process is similar to Channel Access protocol.

+

When a name needs to be resolved, a PVA client will begin sending UDP search messages to any addresses +listed in EPICS_PVA_ADDR_LIST and also via TCP to any servers listed in EPICS_PVA_NAME_SERVERS +which can be reached.

+

UDP searches are by default sent to port 5076, subject to EPICS_PVA_BROADCAST_PORT and +port numbers explicitly given in EPICS_PVA_ADDR_LIST.

+

The addresses in EPICS_PVA_ADDR_LIST may include IPv4/6 unicast, multicast, and/or broadcast addresses. +By default (cf. EPICS_PVA_AUTO_ADDR_LIST) the address list is automatically populated +with the IPv4 broadcast addresses of all local network interfaces.

+

Searches will be repeated periodically in perpetuity until a positive response is received, +or the operation is cancelled.

+

In order to reduce the number of broadcast packets, which every PVA host must process, +the time between searches will initially by short, but gradually increase +as time passes without a positive response. +This interval may be reduced when a new PVA server begins sending Beacon messages, +or when pvxs::client::Context::hurryUp() is called.

+

Server beacon destinations are by default configured using the client configuration. +This may be overridden with EPICS_PVAS_BEACON_ADDR_LIST and EPICS_PVAS_AUTO_BEACON_ADDR_LIST.

+
+
+

Environment variables

+

This table lists all of the $EPICS_PVA* environment variables understood by PVXS. +See Client Configuration and Server Configuration for detailed explanations.

+

Many variables come in pairs of $EPICS_PVA_* and $EPICS_PVAS_*. +A Client will look at only $EPICS_PVA_*. +A server will prefer $EPICS_PVAS_* if set, +or fallback to use the associated $EPICS_PVA_* if set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Variable

Client

Server

EPICS_PVA_ADDR_LIST

x

x

EPICS_PVAS_BEACON_ADDR_LIST

x

EPICS_PVA_AUTO_ADDR_LIST

x

x

EPICS_PVAS_AUTO_BEACON_ADDR_LIST

x

EPICS_PVAS_INTF_ADDR_LIST

x

EPICS_PVA_SERVER_PORT

x

x

EPICS_PVAS_SERVER_PORT

x

EPICS_PVA_BROADCAST_PORT

x

x

EPICS_PVAS_BROADCAST_PORT

x

EPICS_PVAS_IGNORE_ADDR_LIST

x

EPICS_PVA_CONN_TMO

x

x

EPICS_PVA_NAME_SERVERS

x

+
+
+

Address Spec.

+

Entries in EPICS_PVA*_ADDR_LIST variables must be in one of the following forms:

+
    +

  • <ip4-or-host>[:<port#>][,TTL#][@ifacename]

    • +

  • "["<ip6-or-host>"]"[:<port#>][,TTL#][@ifacename]

    • +
+

Examples include:

+
+
myhost

Lookup hostname at startup, use default port number. +Use OS routing table.

+
+
10.1.1.1:5076

Explicit IPv4 address and port number. +Use OS routing table.

+
+
[2600:1234::42]

Explicit IPv6 address with default port. +Use OS routing table.

+
+
224.0.2.3,255@192.168.1.1

IPv4 multicast address, with Time To Live set to 255. +Send via the network interface with address 192.168.1.1. +Use default port number.

+
+
[ff02::42:1],1@br0

IPv6 multicast address, with Time To Live set to 1 (roughly equivalent to IPv4 broadcast). +Send via the network interface named br0. +Use default port number.

+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/nt.html b/nt.html new file mode 100644 index 000000000..45c5fd44f --- /dev/null +++ b/nt.html @@ -0,0 +1,375 @@ + + + + + + + + + Common Type Definitions — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Common Type Definitions

+

Library of common type definitions.

+
#include <pvxs/nt.h>
+namespace pvxs { namespace nt { ... } }
+
+
+
+

Contents:

+ +
+
+

Note

+

The nt::* factories are relatively expensive. +Call them once, then use pvxs::Value::cloneEmpty() on the result.

+
+
+

Forward Compatibility

+

The Value objects returned by the NT* type builders are considered part of the API +for the purposes of the Release Policy. +Addition of a field is considered a compatible change. +An incompatible change being:

+
    +

  • Removal of a structure field

    • +

  • A field type change which restricts allowed assignments. +eg. changing int32_t -> string would be compatible, but string -> int32_t would not.

    • +
+

The status of change to a struct ID string are currently undefined with respect to compatibility +as the consequences have not yet been explored in practice.

+
+
+

time_t

+

Commonly used sub-structure to represent a time

+
+
+struct TimeStamp
+

The time_t struct

+

// equivalent
+struct time_t {
+    int64_t secondsPastEpoch;
+    int32_t nanoseconds;
+    int32_t userTag;
+};
+
+
+
+
Since

0.1.4

+
+
+

+
+ +
+
“secondsPastEpoch”

Seconds since POSIX epoch of 1 Jan 1970 UTC. +Note that the EPICS epoch is 631152000 seconds after the POSIX epoch. +(cf. POSIX_TIME_AT_EPICS_EPOCH in epicsTime.h from EPICS Base)

+
+
“nanoseconds”

Number of nanoseconds since the start of the second.

+
+
“timeStamp.userTag”

Extra site-specific information which may provide context for the seconds/nanoseconds value.

+
+
+
+
+

alarm_t

+
+
+struct Alarm
+

The alarm_t struct

+

// equivalent
+struct alarm_t {
+    int32_t severity;
+    int32_t status;
+    string message;
+};
+
+
+
+
Since

0.1.4

+
+
+

+
+ +
+
“severity”

Enumeration of 0 - No Alarm, 1 - Minor, 2 - Major, 3 - Invalid.

+

The meaning of Minor and Major are contextual and may be different for each PV. +An Invalid alarm severity means that the value field should not be taken as +a meaningful representation of eg. the quantity being measured. Typically, +it reflects the most recent valid value.

+

A UI client may change the state of a widget displaying a value which is alarming +by eg. changing border color.

+
+
“status”

Enumeration providing context to “severity” 0 - No Alarm, 1 - Device, 2 - Driver, +3 - Record, 4 - Database, 5 - Configuration, 6 - Undefined, 7 - Client

+
+
“message”

Arbitrary string describing the condition being alarmed.

+
+
+
+
+

NTEnum

+

Container for a scalar value selection from a list of strings.

+
+
+struct NTEnum
+

An enumerated value (choice from a list of strings)

+

+
Since

0.1.5

+
+
+

+
+

Public Functions

+
+
+TypeDef build() const
+

A TypeDef which can be appended.

+
+ +
+
+inline Value create() const
+

Instantiate.

+
+ +
+
+ +
+
+

NTNDArray

+

Container for image data used by areaDetector.

+
+
+struct NTNDArray
+

The areaDetector inspired N-dimension array/image container.

+

auto def = pvxs::nt::NTNDArray{}.build();
+auto value = def.create(); // instantiate a Value
+
+
+

+
+

Public Functions

+
+
+TypeDef build() const
+

A TypeDef which can be appended.

+
+ +
+
+inline Value create() const
+

Instantiate.

+
+ +
+
+ +
+
+

NTTable

+

Container for tabular data.

+
+
+struct NTTable
+

Columnar data.

+

Unlike other NT* builders. This create() method returns a Value with the labels field set, and marked. While suitable for an initial value, repeated create() could result in re-sending the same labels array with every update. Users should create() once, and then Value::cloneEmpty() or Value::unmark() for subsequent updates.

+

+
Since

1.2.3

+
+
+

+
+

Public Functions

+
+
+NTTable &add_column(TypeCode code, const char *name, const char *label = nullptr)
+

Append a column

+
+
Parameters:
+
    +

  • code – Value type of column

    • +

  • name – Field name of column

    • +

  • label – Display label of column. (defaults to field name) Only used in create().

    • +
+
+
Returns:
+

this

+
+
+
+ +
+
+TypeDef build() const
+

A TypeDef which can be appended.

+
+ +
+
+Value create() const
+

Instantiate. Also populates labels list.

+
+ +
+
+ +
+
+

NTURI

+
+
+class NTURI
+
+

Public Functions

+
+
+inline TypeDef build() const
+

A TypeDef which can be appended.

+
+ +
+
+inline Value create() const
+

Instantiate.

+
+ +
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/ntscalar.html b/ntscalar.html new file mode 100644 index 000000000..56fc067de --- /dev/null +++ b/ntscalar.html @@ -0,0 +1,327 @@ + + + + + + + + + NTScalar and NTScalarArray — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

NTScalar and NTScalarArray

+

The epics:nt/NTScalar:1.0 and related epics:nt/NTScalarArray:1.0 +definitions describe a primary ‘value’ and supporting meta-data. +In the case of NTScalarArray the value is a 1-d array of primitive type. +In the case of NTScalar the value is a single primitive value.

+

Both variants include time and alarm meta-data fields, +and optionally display and control meta-data fields.

+
using namespace pvxs;
+
+// single integer
+Value iscalar = nt::NTScalar{TypeCode::Int64}.create();
+
+// eg. access "value" field
+iscalar["value"] = 42;
+
+
+
// Functionally equivalent pseudo-C++
+struct NTScalar_Int64 {
+    int64_t value;
+    struct alarm_t {
+        int64_t secondsPastEpoch;
+        int32_t nanoseconds;
+        int32_t userTag
+    } alarm;
+    struct time_t {
+        int32_t severity;
+        int32_t status;
+        std::string message
+    } timeStamp;
+    // if NTScalar::display
+    struct display_t {
+        int64_t limitLow, limitHigh;
+        std::string description, units;
+        // if NTScalar::form
+        int32_t precision;
+        struct enum_t {
+            int32_t index;
+            std::vector<std::string> choices;
+        } form;
+    } display;
+    // if NTScalar::control
+    struct control_t {
+        int64_t limitLow, limitHigh;
+    } control;
+    // ...
+};
+
+auto iscalar = new NTScalar_Int64(); // not safe!
+iscalar->value = 42;
+
+
+
+

Fields

+
+
“value”

The primary field. May be any pvxs::TypeCode other than Struct, Union, StructA, UnionA, or Null.

+
+
+

“timeStamp.secondsPastEpoch”, +“timeStamp.nanoseconds”, +“timeStamp.userTag”

+
+

See common time_t.

+
+

“alarm.severity”, +“alarm.status”, +“alarm.message”

+
+

See common alarm_t.

+
+
+
“display.description”

Text providing some context about what this value/PV represents.

+
+
“display.units”

Text identifying units of value. eg. “V” or “Hz”

+
+
+

Meta-data for numeric types.

+

“display.limitLow”

+
+
“display.limitHigh”

Hints for clients which can indicate inclusive range of possible values. eg. a UI gauge widget. +Ignore unless limitLow < limitHigh

+
+
+

“control.limitLow”

+
+
“control.limitHigh”

Hints for clients on the inclusive range of values which may reasonably be written to this PV. +Ignore unless limitLow < limitHigh +Not authoritative.

+
+
+

“valueAlarm.lowAlarmLimit”

+

“valueAlarm.highAlarmLimit”

+

“valueAlarm.lowAlarmSeverity”

+

“valueAlarm.highAlarmSeverity”

+

“valueAlarm.lowWarningLimit”

+

“valueAlarm.highWarningLimit”

+

“valueAlarm.lowWarningSeverity”

+
+
“valueAlarm.highWarningSeverity”

Hints for clients on the ranges of values which will result in a alarms of the given severities. +Could be used by eg. a UI gauge widget to place markers colored by alarm severity. +Actual alarms are signals with “alarm.severity”.

+

Two value ranges are defined. The names Alarm vs. Warning do not have a special significance.

+

Ignore *Alarm* range unless lowAlarmLimit < highAlarmLimit

+

Ignore *Warning* range unless lowWarningLimit < highWarningLimit

+

If a value is within a range [low*Limit, high*Limit] inclusive then no alarm is expected. +If a value is < low*Limit then the alarm severity low*Severity is expected. +If a value is > high*Limit then the alarm severity high*Severity is expected.

+
+
+
+
+

Builder API

+
+
+struct NTScalar
+

A scalar, or array of scalars, and meta-data

+

auto def = pvxs::nt::NTScalar{TypeCode::Float64}.build();
+def += {
+     Member(TypeCode::String, "myspecial"),
+};
+auto value = def.create(); // instantiate a Value
+
+
+

+
+

Public Functions

+
+
+TypeDef build() const
+

A TypeDef which can be appended.

+
+ +
+
+inline Value create() const
+

Instantiate.

+
+ +
+
+

Public Members

+
+
+TypeCode value
+

Type of the “.value” field.

+
+ +
+
+bool display
+

Include display (range) meta-data.

+
+ +
+
+bool control
+

Include control (range) meta-data.

+
+ +
+
+bool valueAlarm
+

Include alarm (range) meta-data.

+
+ +
+
+bool form
+

Include ‘display.form’ and ‘display.precision’ when ‘value’ is a numeric type

+
Since

1.2.0

+
+
+

+
+
Pre:
+

requires display=true

+
+
+
+ +
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..d92a466029baa5d060a0cf5e5a1f8c53bd12f818 GIT binary patch literal 17979 zcmV)LK)JsoAX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGkVR#;OC zBOq2~a&u{KZaN?_E;9-vAXI2&AaZ4GVQFq;WpW^IW*~HEX>%ZEX>4U6X>%ZBZ*6dL zWpi_7WFU2OX>MmAdTeQ8E(&DAx9dH2u%`QhWYe}D7wpSSNny!rX< zrJ|RMZA*N7^Y)iBrS2A=KBnbt{qbQro3HDIlDWjkPyLFP<+5MF*}N|LmF!jM_pqE_ zF1aqN^|#CA?Y}ORxme))aJMQK%Di1%#`*Ah@%yDB>&x<@%uivRK3^#I%kuG@&^i9N z2>Bn&#pA=P^zd*~ALnU3Tg*{(wn&?jA78(F_eF8OSN7cx3I86_-`v#MT{%E`7nb3E z6jUScYCPD(mp?w;U8s?63eENiZf@?%mvYyKZ5#1JSg*@+K8AdCbAv$|{`}?7hfNcf z`6H2i33rcWpYW}s(*CLN?J51u&EFS`yC;;g4C}?R50)ajR>1G?7GW*L2u!;r?S?gK zG^|mruy5vTZbpFWhOi5ARP}X3*abPN>bfE9f^=j0o#T&gXAeJJU+xI{4U#^Pxz7r2^J0CTgFG@NU zxm{+OITzdDha*5DYVDy$Q+-_TqNe7Ti}G>yOx8B<{=boG=sUJAW4VvzP_1?vPqQg} zdqjKyvM0tRoE@Aam+bW-m-j!s{jfHxBjfy%Ozpn4te=5BX@cpdZi=YUxH3Chsi|G1VQ??C-_0<0qXHr#>hE+@E$OE8DHQv}uxKpS%B`gCvX z({<_-^eLjd9Y!a9+p^$5>G#(MPtd1J4~#baj>Xshy?V3;dxShiZnHt?z@9W-ju-Zi zkf%!BF;Y5~j|WNJK1!M|rb^vCLfjO6a=1)=i2Lot)^M#74_uHvk@#?J_8E8Zvg%1I zAFr?;V^3)hyM^dLe@yF%k^`X|d#dCF(T4u(R0VaiOLUAqN%CL2b=0p@mDI^r)G_vC z$vgDauTvG($$r-{_GHOBbk(mDmDTa4+7a@%Q`@9nU;R3#^@%A`6F?{OG^rbeHtay# zhCkOni!47JV%sh0-a^YW>{GyezgffSBdkgtp8KW}z4kDVYu*j_QUSpp`ilexJN%al z5cct3CQ#UMc-esAh|7xw4hMW*EPy!T@?wF+j?c>l6bBq$D6rV$@j?N{0f!d~H1>GB zP{47(;e`T^JsvL-fb8SHOdzu3@KOQE4*w+slS3Xa6`<^Kd9gs{kjF~}EITeQ8Mqws zc&PwppUX=HGKV}~Dxlft@=}4#A&-{|aQ3;pOrUeX;e`U8Cmt^r_#AL}p#W&MYT}qN z0nnDTH2|8e9_Opsr+LXEkU4uMZ$&@ZTIz?Zh^`fIvCRE;+K&)*L)Z$rO5rXnM}?Md zN81kEa(bmt<&O@q(C6Qk+HYscZcE=DlON)om+0xl*$(XqwQHx(y;)bH(%oCxOVBsWc7LR`}2q!QVIV=dK=F}-`so|SA~l#*2^+na79$79eSWnIw#N5 zbl%`SP2bxtxUS1IyIlUpwaODJ-!1Oo}e&G z-}W8+U$e0W%*nr~SUvl45@J`M)_Ff|{43Vue^~!H43D#C%2U+xug7rrX1-bv1NBdI zosIZZqJI~S;qa6oWuWX$u9S<&Q)EBOp|88U54&?iPdc$K7x%qv%^sK{qT4SA*FE>( z#`;ph6_K2_l5XEnIGH9+suf{unX%2eGVs?rHBzxgFVUj9rKqRu`_p;2{8gy}CC3{fHK^TdJ0! zvl`dJt8M{TS83rs45qYjH~w9dvtpPpvY|OYm^Wq4EI3YQLA^Xka77fS5kGx8YAK-u zkE(pSxq88xZHPK8*b%{kMP>; zmJUHyODk``96LsOf{z^`7vKlC@Fu1`Y1zm5U@d7jG%dDb^Tl9OHwb%}mFoxnkXv@8 z+Lsj$02{j9MCL!Vb=0QJ&CL%3)_unE_~k3`_^tdoU=e04mjRPz1Q(zT4K#E^vp0Qc z1!MmB@DV}gM|}5bxl7e|G2e|~ZL|l_GmLObyEm`1PX}w!o3C0f-*3J!8JFj~1jNAk0=CV!?zs&B-;&I$i zV$bwvd3=0WEJty0JK}Em$2A!jWhB0Ch|i)whfD)41<{)g`2_|ew8v8e zJx$BjMYJw%H#ZMoI@jx7h;=3%^5yjGQcrenM}Mk;5RtR*w%=k7-S!Zo^XSJ{m1bPH z@zeol&t_8ZIh3SHNq^-;*sH$-H6PWTzjo169Qz6@H^*oRg`eTx76 zY(86k9_H4%9nmS=Kgy^mnLX2;!yFeK?}2wk#``RmW%YQsp1{Ox5Lz6F_vZcPtJ~Wi zB8-mnCd=~EMiq}*?>MBrgpD5ka{Ttea4xz5X{jU^A0Fc>EoTq($>pkU#Tg%AznolS zmW2*Mx(5F-tNXC}?e&1gx^q0aJV0v+tj}`CpV#PzaZ)_%&gsoyjsZu=aIMDZBg@at z`Hx-3kG{(tPgJ+vfLoLHrR`0x-uRp^cE5gHyB*+JuKy_OYcZ6-I?Jp5*{N~Njvl0H z;r7#>%YOxic8hnG=ex)2wdT9W^R4;*-RrCI0@hhxY0OgQGc&WHZ&9*)Jes|}<>SM8 zG#mc}ah_Apy^wY$U7I0$_d-`w`(^zTw22O@k;ZF0c)>#CLm*8dJYb0EOi zR5}NYzorKIJS+cTK`&$)D=Z_m0M zyZzfkyxa3;ZBGA*5aUC@D@!vf?tTX73O)8&)Ur;W-yvQd5fARM;$k1D#kK9?*_FiL zrFf5AXLyDf7u%nTaE(DWU6xg!4UMOR&n+Uz6>T!?e{!^H$A5{JB(8^n zhq({Aa&wG#S%7s|uci%^1_GwU?0@4Db)hN6|FZlEq4YdI$ce%$3z z*RZZG&%>AZqmJFQOX8p4CQ8#>i&|c^@d=Q5O7uy(XF_Q%Q?u z9v;25i()o#6e>Kcjmx3JS=q)1c3)G*2{GT-6mxty_%);)eKn(NVw}AoaZ!ko_cR6x zvlF68w0q=Mblmvg;@d6BZ5P(f&E0@R!$+w4t~K*-I}7|6lCq#5t8!QF(V8DxUe)Np z<$RCk)_+S0jGJs7Es!l)CN4;Q8GV()Y2u2G2jw?~Z{PiprqZ9Z+X$F;)4KT*x~;XD zMhb=rHV*DuIM)=bz1?Pu1fvCO{O0G^2NSv-OrpHq7C!=6HFuwn`x0NZqnJ(ky*Tb} z@#)i%R_UnGrsVArC4PRnJ3PUAmR_RxDaMm=><6-0w>Uvrw>WX;j-vsst3=O8C#f&?0o$LsxPW;2#>EEm?RVcky>fP;mj0>qZ9B-ox<2D|RQCyX zSdE`?yDI&mc}47~&YP#jT5IlhB)6?Vo%L>k{NV(%qw+gwsHOFCabyDeNo%*XT~c>7 zYcH|Sw{3H~64BzHqvYPwcF9etcgNr=BJ2YF^7Q<`KvezZ@V$~2*k?5~5Sz1S`eP2i zoV@DLF>md*Y%4&MwF$QG?(u$pVS*jwarR95{0b1%_`a{$!RpKdM=#3tF2r*8_1Sh> z$E$N4q=9#AI#kdWa+vnrVRq?U?w=iw@?f1gL{T=#lfqs6ND2*bFwu1unTpoLz&;IpTK0d6MZ+59YP`amVyFYq51_lJHs60&R_ock zxzDj0#mt@JoZ;E#PPQ=mp@q|lUwI7Po}#p0HBM8M9;0{U4C)8pk}~KR|I_0vkLdtK zgxxJZ`!ruH3nh;o*S&lX;0%|J{Hi^fwB}bm;jvoKj`+w9c02Oh*+mZM>~KH3`*VUu z>BFuom22NdYfI(Y!lNbEYR@{HrgA-oZ%^gg6aF-n>j`{kD%YMm<9tHZZgyu~3~(gQL6p zG_8t5`HqX{_nLG1kKg#$qr5o}=VP_wC#zw_2E7-foNex9;psyC6AIWu<2D_$! zn=(VR;10F}YMfTsg7%u42Yg2BgE1U2kz3D=^<(9B0@&{stMz2A{t2polkV{!-J92vq`9fFoZb$03v@c|W81Vp73AR>y`dfkR{!C; zeK45+s;vJ9{P-okIJKHweJ&61cIQBkkLmRk=jP_~?9=D#G|aUnyIcJJR}rl3BG<)b z)DtM|nJvMi*SL@@3VPc{63*J8-P9Aw#gNm<-TpPmW{6yStj?yONq5u=Cb?? z%C%aizlv0w>z}V%pJ}?dN45dsVjtv;rbtt`oW2Eh3_o&fe?xv|Yk!CTsjMf>y(jv^ zZkt_ZIDLXm;XQd44QAe%ySXRBw#3cHJnm+zN!>|4`3~U>n`OCQd?{lMq}!2Sh+~eq zO&&1g7*A?Xv5(Prr0mm7uJkoTm^xWT%J4WJ*Xk0KXGZU;b;-J)httrW#cl}!dO<59 zZA0F9PX{h~^WnpnPS7W(>$VdR#(TXE>2&L)H@4XT+_oKbKDvHzS&Wn5>1l|4ZF!or zd_RTRU0nPzzHzwN$2rrnTZZpT$cuT)?q7e7@&M>8%l6wIy;*f$^myjbq%-ct;fHn> z4Z!XDjs?D}GrCxpGi$>yP^;PM=Z7+%P%X1TI9sp9{QKE*weEPzdBDh1he$0)FP;_B z*|~R!(|r`=-y+(NVYTjl+j)RY<{0aGQeC6Tt}0&JNu&OHrt2inQ;CshdX6N#LaTih zQQIzp4Uw?@Ue%Q)yiQ}jxTt;AYpZ~Y$h)_n4%txbH=|YQiLKI`Y3pf-{%p=4LpWqJ z&?=5%_#A-s-E7zf8XZuSHEXpV0jP-XJnGF&{u2?~EDhRq*~hnAfJ=NRE?kY~q8svV z9v@0rZr!S3ZDcl-mymC6o;EZ_;j6a?sfo@pA#XR#?uQ<$J7uREoHmcDmFuW|rc((3t{o2m$$VbMvM?!SR+h13jCsjOrFl~s>Hu#GhxfNRh!H&@(2MLG) zTb#$-&#mWvWkI_3dcU3+<5r;#`FAfx9kALgKu_dlHYk_24_X*suiMAS&|%&#E+!pu zJ~eQgUDvJl4F7~NzTd{6#Zd)@=Plug9CCj=xcIc7d_lFid5l&O?9wQ@y z?3p2V9EVolu^;%U(|CZK!fO4?;vzI9xo$%@8~WSBPv3}Ne!jr*=H{25`}XtoShpnx z?aE?&*ow!QL63kJb4ZOy*vnG-r}jRAZfHB9@5689<0di~h0pmOLMNBqD^~yOe~)XR z*&i3w<1>S4iuf|47_o4;REqJgU7=H|`1};sMi)O70ekbc?>#+P()*ol{%~Ig*VfG%+SDjLJ z?Bvo@T(6HWg}0-+UD;FW=e4$1ak03&DCG}_fay!zuk{J&fB7$$5TDe`6XxCO_Wjcz z2ajmB;decfdVM}$dOfo>j?b#B-%$_t8YE9(c1yPRs^$q~U%5v>{}fs-0$jkw#MvWm zxq5oC!`jaF%xlYEO@i6{;j0VKD1m`(ZnmnUZK57%k^Yd+8YR92=s8K7h3?0@^_Zsb z68o3W%f;`j%c|boa!#nF5Tzjj`EAt&bc1CdhQkE-#e++TLaoi!2V!-kE8_%Ein`bBu_xI3s3CorqHhRU7yl-yBo%L6jpudc=qiq z<+2Z-YC?uNXX(^lG)v+vn;2#$V0LdXpkzL-e0s(PIY%p4kT!{f}?xZNPg3 zafdY9hsK&O|3(pBb1xJFv?-StiAwE0Ys$X*`>q6KjCi#brz5D6)_iw)c`4H!MSo|l5*h=t`2cAMoNmk26ijv3Zn5nf`<+Jrd#W9#7L;)yg zLlMf?sl}OZCvKe*JPrt zm1U8*_QH(9G&Kb&0{1}+u9zsUMCB}6mSvUm7|bXtFC|8qbadLXWP}yf`4STvK&DZc zj_1To)yrb zy~giKJuH9lf^ioKO@QijmL)h{i4SeYb&l1hyj2;)$VGQvCUGV{*lA_NWm;(6iK zpmFR-R3AJu=rtJ%^T`*TYLTf##+B41jzhJINu_1Bky(|ct~pA^f$N!bQLAyNP5?B> z;H2})2BE8Sn8hq|hB2Z?wt&w%b5m`NmP;CNs#L3@tN6ezGMY7QEnE zg}_VHS&wYjWQDBKg{l~)u!VN1=(MUMPtY#ej6*FUsge~dkT)eIUBvLRg*k(v#qFT+ zy15T{K(Mz0)?OSUFzzA-2Zm#m866O-W|>QaMr0Z@egvZD=+5kz*A-pNV*qH))`=`4 zQ(**RO3t`wQmjnpDkU#jNF8DjNkik0K&;L{HkG~NJ_c=+C^iYSMU)nuFdUH^8LRY| zc_QRuD%V1U6(eNS&`h;jU3laIzJ=xvlUid+ zSNLvfgp6oEnk!6mCXEc}6b-#9EaNh%kVf>35ebGmupBV|;1&fFFvVSv%y9J67(@@# z6usp|IJl>1L+EBMJ=_Wy8Z`#7un>}QP&}ML*J#*M{KQaKHl;8^Q&<@jr^)DSR*qGe z`c%1y3WFSd&PE`nB%*;$h?!gH2(M+)0?n8eR7V{lqn9d42S=hnRoX!FusB$V4Btd& zHA07b?UOB1aR)y{!FQGs(go-;vifceqD_X}1!;vZDZs<=o@3OT(BT{r2;wH5 zYE3S{y;IAch=)n2d?= zOA7qXnUB;Q4?#v&r~LzipERHA@?1 zd5EwnH4uXQGbK4DW6&6x5jGJ<6BOGN~!hbkkl^M$=+mbnt4)LVZ0ZRk zT~Y=?ztAEf@RL^AT#KS%%s!IA^30{<5(PP>WlrYNop#SnqP zc@YYRl4=C40u2@NM0lGmN1*M3L!1p>32mdaH8BZa;doAkFCzIW94%)Q4}Z>B2|b`} zU_n7?PlR`gI|TKBC7aABGSaZw0zoTUE=?Udj_!K{m&|KS3O;F+Lf8;sXcW_IBD`0T z!wvNqF7WjnV#18*IP+X0JdS84!Ux7&feH75eADXSvr&MXyzr6gG7&x^{EF5v_~t=y zC@W^YuP{*D!8oxp5x)2kxL{B-!Bj`<8Bo01Mhd42S5x6@;P5g-@>Y5pEYLj&vSRVl zc%9TZmG+M^$%sCa({cn$3?5>%o*Ap*7$Xvd=Z-Kx!y}7qItR^)@})qF3%H)ph3NxjD-iL3RY=Ui1Go+sgrqex$GAn1T0PHP(`pQ} z68<6rno(TdJx&_k&*aTw8!yxt74eCNBcX&wTbszNV6HkporBDlWrOg*OUoi-)~JN8 z)HY=$OyScxXb)v-Ba{b=u$RUmR5w0hT6q}-m(w}Ga>CO`k7PF2lQeX!V&kE^ORSaG-ya@x( z&B-vGgF}!aS*!`Jt<47Gg;fm9qE&?D31vEm#DdPmLSs()paQKb*cv$#@FdJQMf-kp z4r@Fqg-@DUm~SrO&?^Ts!?mm?Csz=4Ff*=kb6JPk-NxG9-!JAU?)uf$G*2Nel zvw?aAf7UCrLokPM3jvq0Ku3@f4DB5;ql+~sODU7t)d>BlGgN-EJR-KtS;GsHa2^e< zdk$dt%;ZOUUhR08om>AnA#K*&i`GUW$TuNzt%XQv45$Zq>I|l%Kl*Hunw`S3TEF@E zb??pdP1C*o<=6Lb+K;)Mqo4{zTNK*Ud1!GKB1stPaTb-wn7(N*;tPETg&>=!y|>8oGkJ3iI9g zSgFuLIJA|5@F@ludp8l?Rquf*J%cNSp;j?6l5&9=jtFp~?Am9?x$=xjnBU4JqIg?1 zIB2i!u}?J=-5|h2xUI8R77n*>7?W_6OO)1lnOJcNO*9cbW27gkShUUx8&qPLv#x|p+lO|l>`*ceqcAvlhzP(% z=IDVyi^6amkGHdjq8IOI50-hUO%#wGJ|`T0C~pI1d7>6WoC)`~!ljq87^@t7TNj07 z%or~C$T8ELdED@!q@9hWpmcwSV0+0jM}Rfw7NH~y;mz4>!UYlPO z9(F&3aJN2V~72iuFMhEfYs06m8Ij!Z>eb zC?ZBP0Xc_KP(5a&g#)b+OC^fFomI_Yjq%7_kcNs9(_EmFU~y`YGMNCqn1i?Dkp-q+ zaz??}2l(Ld#Ni6lK`|b)hgF_{>~&ELcGzV)zNTQ_0>Z$=Epx66*@r$sh8{IS(SS7` zp?pzNxGW3C6QgzH@yJq0>5PQZfIXwlnF@oM937KX@TTPiWS^mfBFpgkg3XMJ8Za3V z#nKW7pD^lRWo>{4!nk9iCTo>78m?QFvQjsWM^;{wXJ)0LBb`zd8x46>PCpCD^heOoHg+kxk--&Rbbm;0#6utII8XbQv@0ya{6i8b6aEDbAOg zLW&tPClsqt0cq2O9<^l^e6ERjRHR6VqXL9maoK*3Hij}IC2(s<;Gc~)s3 zQYkvj#sr2SErxi;i#H}tK}JN5$%5z+VG_bp&kE+C=h`X8hMZ7(y4~7$MP)}o)|gqX zJVoB#FqSktAgC7^70XiUs77HL&oJn<)4Z18Rdv=2QFYMV*OOxjprf}D1tk}{eO z$!S<*ubhD6$y z5tn+VM`5aj=!ZqkD!>`0K1K?w#-m-CRD29(t^u)Itk8B`Ap8*yTsU2)sM4zdG*U;aku(rvru_ddbf1>>h@)!o%zRjCa6cK&Hc@Ccz+{ismz zo9%b|{kvcM)pwgez9G3cLEn1uTbUor{An35a+ZHTMTQ24ou0q~!O5IZz ze+kPOrFI9i&5+p_YJU{Hy50Oi1s}@twB?T~eA|?wA+-9Y&dOaLQjdn9N%uE|>QkA| z=DGZFDA(@OO)cKguit!HE*>BLpVe_o{j2$WSA+ld;pexn-j{6xsSVA;mva>V{loiz zzWN7!vifE=Pj`>GkPbP24fIV@knVxL`{)1s@M<=H_2=So`6@g-+|ANvK0ViJ+cA3; zYKS)N@}D=06R+xGiI2a1^=`RXFVf=fo7o~AP;al&zM}1fH}iG*w4Jy3;`3th+v=nH zOox7~&8oPf4KJ3q{zdUxSSIK&sy*KMf4ZMbJ#n}Aw83Bqc#6=_wuvVPLzx6Eu?vIP zHQIXCRy=_qS{EAT1+K7!V-g)5tYAesrL8b5_W}tpe+ho2AlKATNLpAzq!4%v3b>TYP5gCRH*OJb(M>wHqJ{P&u z#lo#d^ums>wjEaW7)vlFVsKIx?+op?hzJ){xlHF1gH_kW3X;*CDu^oJWGEX8EvFlV z0h%dZvcD=b#k7x1zyURw7%pKvAu3f?z-2Pd>Z>x-MhlIBtPm?POlt*?J|S3Vma|g% zRl6k6{UZ30h_8zXnj%XSMO18ksVv8ERc2AyYQPa8JoH3SvDT6}W@(j(P-Gm$tc1$x zut2dGsLdG*hftOKR1jg7Gz3d>lZ-6VE5o6V>6Vd(nm3+%>(hlhEyrLA9(qLlp9HEY z8Db$Otr0cD*M^^6t_l_qJ}SB{g8{;-mXS_)1-i3mZPkLQ>v9t?Z%#s^Gn1j&5wTjj z;vBL-NT0pCE;j`6Nd)L|=p=>6vT7KI>J0Y|rh#3Vn{i$+p_qpOwMs_MmF2Q}lMySb z3kMShbF{BWJ-AybOoX`nuc_GhFxzF9c>fF^{+!u1(QeR-TjOSLP<@N_KImTP})D%?Br} z6jp>7n7ne`GG*W}89Xo=Vd12}u%zQPPQa}W?7G|lsZD_+SunjA1?puOHzy-g5w;Y~B{N-lhni41s2m+W7-H#E=5U>$ zO(QuP)n>Ft$~+qt>HL)$f@PW2Izc*37nF>kbS*x>_r^yCPWT`!&!uM0R;s76+WV}7 z(t?73=y)B31wD$uK|3J?JXmF56@{kL?Nutz+z>1;VoXKRK?kL>&lwseml&Zu;d918 z?Uh-{IaeEeNib#J6a*%a3N=SxnnB)ArbDiXZltGh)VXRI#$BpW7o|%bHKVUh=&t(2;B^X&WxHz=`(YP4=TSlzrZS8hj(B?VHNC8 z713i-@)Y4ss%!HbW=^N`8)o7z^DB_vBwm3PT{YfA-Px?2NNu5^6M|VSo!1yt zB`HcBWVxcuOvVigXz3;`CNhi-XQ74&RV9MgTzZi?Y}Hw;-LmNZ(%9izX|syw;t#L>{`l#e<>Q?86fbNHynmd}iG~jTufADr zo;5!@W=WrI8e;qG`MdC`e6xB!6u)h_y#txAwnye^b8qwUiDo%GzIjsqbTjaf;84%) zUQ0d@Xa5D|S5J>#lQ!6YIQg5^jFyr=l}kIEPvy1?&6~e5Hha;b+>UPZ-t)es&xbQ# zeMfJq?j&n|tUoW|GM{AnJUr3)%dXHjtM&3Rt#=FAKQ0!(JwDtnmy7dPO%ADkYL>q* z*zYzHI#F3fWd$Cvw??uQN@CnnG-v2QTv+z~bD?TVC2BYt4oWeft3xF;c+rSu@e>#?{(Bf!=+Q))%y z5-;3WnJZ;XvD_W6Yg`XE(1}lcq?ERjBa{mmETFNx&?-kwFUMG=X6|rRq(Nu|*B8N2 z$!N?hrL!-_m@*_dm+?)|h{_P@+aOeNvN)!zsxQa5R)j>nGU=jo%pmM`*~>`j-m*DP zS#?Fmg4PgH5yqC9xc4zo>RC!$Y;!$1yK_y(6?IP4c_CtntXh04WGUKtS^aS`hbuCs zwf7)XF2?Z0xkTKi5fK^0UAiRway6C-GfALpg&_^WC?j(ak<03YWa=du=SsOLqDmC@ zd&<6I6y|enLdzFZOo8@`q>$PsM4Z`Ws6wqV%3aJ+dHaHljVPJY5!+~Upq#ui8HMkn zk7)mwo5w~*MBT>Q;*+d3E9XnD)+>X-?YVn7#*~pkXsc;!s|xrC)@kmQ)<&l)%Zo9# zng>k>WtC&Jv;aLRl&V2E%c3|=^m$FjQ5JYtFuPD2nNq;T#1tzkFsH0EFUL4%7Cd^^ zqG4l2ed)#>C9d$9$MkaZ*iyO;1I3YqE&;Wrqvcu`Wo#_fy_`LEEE*PSEp*i(afA9s zSmS88t~TVCo5v25Rr1KA)t2(2IFYzxBJ-q@3;g8wVUL|dtH+mPoEcO#Qw9MR{2iuM zgbL#ht{>Mq>K9~;Ae4J6RFv5k$!ai>lNPg@B8{_L;%&kkq}+y9)GVhm(oDTqIHH_F1j4g)-Wdt&CawCe3`x-uv)!jNyS` zBr!`D2QZleh8g8M!7vNO@Rw5{RmtEb`ZQxO3&vrSbJaek0@WS;=%%J!v7nX6p+@f+ z22ON5*-V~1H}o{NK9>3JA9z_%%SKl1PI zhb%7blTj0@K<;*R8DnTaeth%o-Q7sa*Pmy1d0FNo$$tvV-^!5X&4Y}Z zC;O?#8Jo`2(rPCnKgz(SxpRWKpiHKeKCD*ia#^Or*IW&U`3&BaA~^;t&#E#>`OKmJ zC&J4VTt-xrw9-XL#S%X71ul1!oxDzjSHd-~BC+D(S`}+Oj6Y?KS1Ht!S40NGYblcF zh87fxNjW>=oTsCg^fnUQ=c({c!BLY&8#>)o1zqnBxoAt98r)57dsx_9=o}l%#j2Q5 z6P8^@cvI{%fDm!?m}F&dt-x=$i*-b;$! zaApLwN>(&AWr&`RXGVBG)lJ1uwM5F7$wMx8|SL|cxDb|VFk<5+w@o6lCC$5!y?<~{S-@dd`g$1H92N$42ODq;jmELNB1;zY>GSM8dQkl*Hs+FFG@EXCGur|U0 z*PE?luP8^@bPiq$7MWBc6c7DD7k=QC3T-XNk0hsaKaOsrO7g0CT}~z} zoGyJ|o(T;R=_p#&tb);7oyq|8`cgt3?+m>-zGyg6eNlr)Hx1H4fu z<5=9RGaV{5P^Fq4dv}^1V5F2{6^)q&w!<&8`|@EO?jQP+J!dq2{W;9%<*rFpwYWQ< zq_`gjtv^xX4G|2isLC>WIyxh1ja&QV`EkyP@oXv`Jt~y5NQ&Yjc{p$cj7Jc|qApir zV>~n&x}2LDi>2)Vn; zle1o@ggVk=E0JIx-H zskB9F(YG;9gm<)2=;%c_Q+?(1rV^c3kH-2)7H%Ru-IY;jqEv-fUdf2IQU;!cpyV_O*&>@)jTOR}6+vu(k9K z0Eg>nY>Luwfr(IAg33hXI}sicM2%>B*z^iRf`FH$A~;k(*VTtQ5x&@h5e~%YoA*XI zCB^sFa1)D?dg`o2=ulLI7iWT@M^X^CB1DExN5o#Tnksz_-s!;6FiI*fO_p@&rU!%`r~k)+RfhgY~S?4n&gH7whPG zc7$n3B2we@qV;qRl;+%)Sfxk_8pU}QqlGgr5b77<{B#b1o}5djFuLdA8Qo?Qyvdj2 z@m&(rIpo}=!(xG11Jg&TJTmvRWSasazmbmX?H?tL9VHuDvih2(%#>21B(x_&59y)M z;mCW=qY4w@;gs?mtf(q`_*6_o_0ip_sHKV8O@&8jCbU6^6+_p-LbaM!Y#KX2j!`!6&bh>+qhwWZOf1X|7fd@XgH2}aTyJA!D#LVfiWhjHGD&J(QQ)G*=d5gy;p9`~0SIC=T2`gO7l+gty)oZbV z9jvsTn_vgw>{W~-7)HxoW=^Xzjm`Qv|IP>i8Xr+eNpHp3$UXiGrb@)O3at|9^`>j^ zFt!@0h2eCX5aED_JA$#UOG*@(v1{-^+`8EjM$lvhJ=(`Drc()-c-43f9*9~g*_@+$ z7?RFoI}ICbl5$pctX_{(f{bFJJvqQ0 zBM#!z>q^ekdOyV+7?8(%a^qOQ2Nu;y!~k$SXb}TmUoNl@k#^bB6l&7QxYd%g}i6l-{w#64B`r&aynoo->LCoh1uS=B%|rAVRC<2&d6z zi5B{g9~T?NB2cbD`1NEpqJ@`fCB2BF1>J?O$A=e3u}DfWMoT9Qy^xroYy5^D^^GPv zCd?IB(7us#49ce>Ry74N1oWn&^S>dx;}@7lv8Wv0e(=>B_#1RtB_$*1!9HD^L_ODF zAz|f+i2=Ncbo0PQRWrH#bcX*LEKChCQQ}2SDOwo3V{hrAmZz7TP8@~)ES~dk4OhWW z@3H>4%LF(PgCZx(vZ{3ZT~SVURy=bUC3OAX(rCF78;9u`0(S@ipwN7!7a=bMX@5bU4hk7bOvxDe5P}DUcdw7 z+R!Bu0kP@mIZQC6y`KnQr6@XDmgr?o#5B}gR;EY~W@lGNE`#hREF7)(_Ar{`aMrUL z;8QzY4Ku1SLbQ-tn`h^)#D*5#q)35hYa*orpkp#lSjLNt~rkUcG)?trz!AO5W9u>LkzR(JkUR|%hfu}DTQQ{hIMuB4YFVN zi|^93J|c3ZjH8=ppP(3|;EH908j?rJXwO^;I*gi>IRDtS?_gfto7pe8T=iBsxw@XxWTm0)JhiVAYCn$R)Damuu>Dz6uwG9RYaGgT z2$Y)xC!TWI1!w7XaEt}Z5rRr`ta<~LB%AZUl1WB~zMQ8g-i>$U43_hce*XWbEkXI_ CA~{U} literal 0 HcmV?d00001 diff --git a/overview.html b/overview.html new file mode 100644 index 000000000..8fc7f6af9 --- /dev/null +++ b/overview.html @@ -0,0 +1,443 @@ + + + + + + + + + Overview — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Overview

+
+

Basics

+
+

What is EPICS?

+

Overview

+

epics-controls.org

+

APS EPICS site

+
+
+

What is PVAccess?

+

PVAccess is network protocol supporting both request/response, +and publish/subscribe operations.

+

PVA is closely related to the Channel Access (CA) protocol, +which PVA may work alongside, and is intended to supersede.

+

Four protocol operations are supported by PVXS.

+
    +

  • Get - Fetch the present value of a PV.

    • +

  • Put - Change the value of a PV.

    • +

  • Monitor - Subscribe to changes in the value of a PV.

    • +

  • RPC - A remote method call.

    • +
+

Get, Put, Monitor, and RPC are to the PVA protocol what GET, PUT, POST are to the HTTP protocol.

+
+
+

What is a PV?

+

In the EPICS world a Process Variable (PV) refers to the idea of a globally addressed data structure. +An EPICS control system is composed of many PVs. +In the millions for large facilities. +The present value of a PV is modified by a combination of remote operations via CA and/or PVA, +and via local processing (eg. values read from local hardware).

+

A common example of a PV is a measurement value, for example +a temperature measured by a particular sensor (eg. mylab:temp1). +Another example would be an electromechanical relay, which may be opened or closed. +(eg. mylab:valve2)

+

A PV name is needed when initiating any PVA operation. +eg. with the pvx* utility executables.

+
## fetch current value of both measurement and setting
+$ pvxget mylab:temp1 mylab:valve2
+...
+## setup subscription of both.
+$ pvxmonitor mylab:temp1 mylab:valve2
+...
+Ctrl+c
+## Request setting change
+$ pvxput mylab:valve2 1
+...
+
+
+

In the case of the relay, a Get operation would poll the current open/closed state of the relay. +A Monitor operation (subscription) would setup and receive notification when the relay state changes. +A Put operation would be used to command the relay to open or close, or perhaps toggle (the precise meaning of a Put is context dependent).

+

So the Get, Put, and Monitor operation on a given PV are conventionally operating on a common data structure. +The RPC operation is more arbitrary, and need not have any relationship with a common data structure (eg. the open/closed state of the relay.)

+
+

Note

+

In the context of the PVA or CA protocols, a “PV name” is an address string which uniquely identifies a Process Variable. +All PVA network operations begin with a “PV name” string.

+
+

A “PV name” string is to the PVA and CA protocols what a URL is to the HTTP protocol. +The main difference being that while a URL is hierarchical, having a hostname and path string, +a PV name is not. The namespace of PV names is by default all local IP subnets (broadcast domains). +This can be made more complicated though the specifics of client/server network configuration.

+

The P4P module provides the ability to run PVA clients (cf. Client API) and/or servers (cf. Server API).

+
+
+
+

PVXS Module

+

There are three main components of the PVXS module: data container, network client, and network server.

+

Structured data is packaged into a pvxs::Value container. +In the PVA protocol, excepting the RPC operation, the server side of a network connection will dictate +the specific structure used.

+

A user of the client API will interact with Value instances of these server specified structures. +Conversely, a user of the server API will need to decide on which data structures to use.

+
+
+

Comparison with pvDataCPP

+

The data component (pvxs::Value) of PVXS corresponds with the pvDataCPP module. +It also incorporates parts of the normativeTypesCPP module (cf. ntapi).

+

The most obvious difference in the design of pvData vs. PVXS is that the “class PVField” hierarchy is replaced +with the single pvxs::Value class. +This avoids the need for explicit, often unsafe, downcasting (base to derived) within this hierarchy.

+

Further, handling of PVField instances was always by smart pointer, +opening many possibilities to dereference NULL pointers. +By contrast, Value objects handle this indirection internally. +Operations on a empty (aka. NULL) Value are well-defined, +and are made safe by the type system and exceptions.

+
+

Sub-field Lookup

+

Consider the following examples with pvDataCPP. +First, as seen in early code.

+
PVStructurePtr top = ...; // maybe result of a Get operation (assume !NULL)
+PVIntPtr value = top->getSubField<PVInt>("value");
+if(!value)
+    throw ...
+int32_t val = value->get();
+
+
+

It is necessary to always remember to check for NULL when looking up sub-fields. +Experience has shown that this is very easy to forget, and the result is a client crash +if eg. the server type changes from PVInt (int32) to PVLong (int64).

+

This can be improved by using the getSubFieldT() method which throws instead of returning NULL. +Using PVScalar intermediate base class allows opportunistic conversion between scalar types, +and throws when this is not possible (eg. between array and scalar).

+
PVStructurePtr top = ...;
+int32_t val = top->getSubFieldT<PVScalar>("value")->getAs<pvInt>();
+
+
+

With PVXS, the behavior is similar with a more compact syntax.

+
Value top = ...; // maybe result of a Get operation (could be NULL)
+int32_t val = top["value"].as<int32_t>();
+
+
+

Another case to consider is when a client wishes to extract a value from an optional field, +or use a default if the field is not provided.

+
PVStructurePtr top = ...;
+uint32_t lim = 1234u; // default
+if(PVScalarPtr limitHigh = top->getSubField<PVScalar>("display.limitHigh")) {
+    lim = limitHigh->getAs<pvUInt>(); // could still throw!
+}
+
+
+

With PVXS

+
Value top = ...;
+uint32_t lim = 1234u; // default
+(void)top["display.limitHigh"].as(lim); // returns true if lim is updated
+
+
+
+
+

Structure Iteration

+

Also consider iteration of the fields of a structure (children).

+
PVStructurePtr top = ...;
+for(PVFieldPtr& fld : top->getPVFields()) {
+    std::cout<< fld->getFullName() <<" : "<<*fld<<"\n";
+}
+
+
+

With PVXS

+
Value top = ...;
+for(Value fld : top.ichildren()) {
+    std::cout<< top.nameOf(fld) <<" : "<<fld<<"\n";
+}
+
+
+

Where ichildren() could be replaced with iall() for a depth first iteration +of all sub-fields within this structure, with imarked() for a depth first iteration +of sub-fields marked as changed. Which brings us to:

+
+
+

Testing for changed fields

+

While the PVA protocol is based around the idea of transferring partial updates +to some structure fields, the PVField container classes don’t incorporate this. +Instead, it is necessary to handle an separate BitSet object provided alongside each PVStructure.

+

With PVXS, tracking of changed (or valid) fields is built into the Value class.

+

For example, completion of a Get operation for a client is notified through the ChannelGetRequester::getDone() +interface.

+
void getDone(const Status& sts,
+             const ChannelGet::shared_pointer op,
+             const PVStructurePtr& top,
+             const BitSet::shared_pointer& valid)
+{
+    if(!sts.isSuccess() || !top || !valid) {
+        std::cout<<"oops : "<<sts<<"\n";
+        return;
+    }
+    if(PVScalarPtr value = top->getSubField<PVScalar>("value")) {
+        if(valid->get(value->getFieldOffset())
+           || valid->get(top->getFieldOffset()))
+        {
+            // "value" exists and is provided
+            int32_t val = value->getAs<pvInt>();
+        }
+    }
+
+
+

To unpack this. Provided that sts.isSuccess(), and that neither ‘top’ nor ‘valid’ are NULL, +the valid bit mask indicates which fields the server has actually provided a value for. +Others retain a local default (zero or empty).

+

In order to find out if the “value” field has actually been provided by the server, +one must obtain the numeric field offset (bit index) with getFieldOffset(), +and then query the BitSet.

+

This approach opens the possibility of testing the wrong bit, or more commonly, +not enough bits as it requires explicit knowledge about the PVA concept of “compress” bits +for the top structure and any intermediate sub-structures.

+
[](const pvxs::client::Result&& result)
+{
+    try {
+        Value top = result(); // throws on local or remote error
+        if(Value value = top["value"].ifMarked()) {
+            // "value" exists and is provided
+            int32_t val = value.as<uint32_t>();
+        }
+    } catch(std::exception& e) {
+        std::cout<<"oops : "<<e.what()<<"\n";
+        // also handles local errors
+    }
+
+
+

With PVXS, Get completion is notified through an callback functor set with pvxs::client::GetBuilder::result(), +which will throw an exception if a local or remote error has occurred.

+

The pvxs::Value::ifMarked() method allows the lookup and test to be combined. +It is also possible to test separately with the pvxs::Value::isMarked() method.

+
+
+

Tracking changed fields

+

A server should perform the complement of this, and keep track of changes +when filling in a structure to be sent.

+

With PVField et al., this again requires a handling separate BitSet.

+
PVStructurePtr top = ...;
+BitSetPtr changed(new BitSet(top->getNumberFields()));
+
+PVScalarPtr value = top->getSubFieldT<PVScalar>("value");
+value->putFrom<pvInt>(42);
+changed->set(value->getFieldOffset());
+
+
+

With PVXS Value, this is automatic.

+
Value top = ...;
+
+top["value"] = 42;
+assert(top["value"].isMarked());
+
+
+
+
+

NTScalar

+

PVXS provides facility for building some common Normative Types, as with the normativeTypesCPP module.

+
PVStructurePtr top = NTScalar::createBuilder()
+                    ->value(pvInt)
+                    ->addAlarm()
+                    ->addTimeStamp()
+                    ->addDisplay()
+                    ->createPVStructure();
+
+
+

becomes:

+
Value top = nt::NTScalar{Int32, true}.create();
+
+
+

The options are the value type (Int32) and whether display meta-data is included. +Alarm and time meta-data are always included.

+
+
+

Custom Structures

+

Defining new structures with pvDataCPP is best accomplished with a FieldBuilder.

+
PVStructurePtr top = pvd::getFieldCreate()->createFieldBuilder()
+                     ->add("value", pvInt)
+                     ->addNestedStructure("alarm")
+                         ->add("severity", pvInt)
+                     ->endNested()
+                     ->createStructure()
+                     ->build();
+
+
+

becomes:

+
using namespace pvxs::members;
+Value top = TypeDef(TypeCode::Struct, {
+                Int32("value"),
+                Struct("alarm", {
+                    Int32("severity"),
+                }),
+            }).create();
+
+
+

One significant difference which may not be immediately obvious is that the later +will be automatically indented correctly by code beautifiers.

+
+
+
+

Comparison with pvAccessCPP

+

The client and server components of PVXS are heavily influenced by the pvac and pvas APIs of pvAccessCPP. +eg. the analog of pvac::ClientProvider is pvxs::client::Context, while pvas::Server and pvas::SharedPV correspond with pvxs::server::Server and pvxs::server::SharedPV.

+

The principle practical difference is that PVXS uses functors where the other APIs using interface classes.

+

For example, sub-classing pvac::ClientChannel::GetCallback to provide a getDone() callback.

+
struct MyGetCallback : public pvac::ClientChannel::GetCallback {
+    pvac::Operation inprog;
+    void getDone(const GetEvent& evt) override {
+        ...
+    }
+};
+...
+void startOp(ClientChannel& chan, ) {
+    MyGetCallback cb;
+    cb.inprog = chan.get(&cb);
+    ...
+
+
+

With PVXS, this becomes:

+
void startOp(pvxs::client::Context& ctxt) {
+    std::shared_ptr<pvxs::Operation> op = ctxt.get("pv:name")
+            .result([](pvxs::Result&& result) {
+                ...
+            })
+            .exec();
+    ...
+}
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/pvalink-schema-0.json b/pvalink-schema-0.json new file mode 100644 index 000000000..80d5a81f2 --- /dev/null +++ b/pvalink-schema-0.json @@ -0,0 +1,36 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://epics-base.github.io/pvxs/pvalink-schema-0.json", + "title": "PVA Link schema", + "type": ["string", "object"], + "properties": { + "pv": { "type": "string" }, + "field": { + "type": "string", + "default": "value" + }, + "Q": { + "type": "integer", + "default": 4 + }, + "proc": { + "type": ["boolean", "string", "null"], + "enum": [true, false, null, "", "NPP", "PP", "CP", "CPP"], + "default": null + }, + "sevr": { + "type": ["boolean", "string"], + "enum": [true, false, "NMS", "MS", "MSI", "MSS"], + "default": "NMS" + }, + "time": { "type": "boolean", "default": false }, + "monorder": { "type": "integer", "default": 0 }, + "defer": { "type": "boolean", "default": false }, + "retry": { "type": "boolean", "default": false }, + "pipeline": { "type": "boolean", "default": false }, + "always": { "type": "boolean", "default": false }, + "atomic": { "type": "boolean", "default": false }, + "local": { "type": "boolean", "default": false } + }, + "additionalProperties": false +} diff --git a/pvalink.html b/pvalink.html new file mode 100644 index 000000000..d7f1f090f --- /dev/null +++ b/pvalink.html @@ -0,0 +1,331 @@ + + + + + + + + + PVA Links — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + + + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/qgroup.html b/qgroup.html new file mode 100644 index 000000000..6347769cb --- /dev/null +++ b/qgroup.html @@ -0,0 +1,388 @@ + + + + + + + + + QSRV Groups — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

QSRV Groups

+

By default no Group PVs are defined.

+

A Group PV is a mapping of values stored in one or more database records +and made visible through a PVA structure.

+

A Group is defined using a JSON syntax. +Groups are defined with respect to a Group Name, which is also the PV name used when accessing the group. +Unlike records, the “field” of a group have a different meaning than the fields of a record. +Group field names are not part of the PV name.

+

A group definition may be split among several records, or included in separate JSON file(s). +For example of a group including two records is:

+
record(ai, "rec:X") {
+    info(Q:group, {
+        "grp:name": {
+            "X": {+channel:"VAL"}
+        }
+    })
+}
+record(ai, "rec:Y") {
+    info(Q:group, {
+        "grp:name": {
+            "Y": {+channel:"VAL"} # .VAL in enclosing record()
+        }
+    })
+}
+
+
+

Or equivalently with separate .db file and .json files. +Use dbLoadGroup() to load .json files.

+
# Store in some .db
+record(ai, "rec:X") {}
+record(ai, "rec:Y") {}
+# Store in some .json
+{
+    "grp:name": {
+        "X": {+channel:"rec:X.VAL"}, # full PV name
+        "Y": {+channel:"rec:Y.VAL"}
+    }
+}
+
+
+

This group, named grp:name, has two group fields X and Y.

+
$ pvget grp:name
+grp:name
+structure
+    epics:nt/NTScalar:1.0 X
+        double value 0
+        alarm_t alarm INVALID DRIVER UDF
+        time_t timeStamp <undefined> 0
+...
+    epics:nt/NTScalar:1.0 Y
+        double value 0
+        alarm_t alarm INVALID DRIVER UDF
+        time_t timeStamp <undefined> 0
+...
+
+
+

So pvget grp:name is compatible to pvget rec:X rec:Y with the added +benefit that with the former, values from the two records are read atomically on the server, +and delivered together.

+
+

JSON Reference

+

A Group JSON schema definition file is available. +Keys beginning appear in contexts where a name may be either a data field name, +or a special key.

+
record(...) {
+    info(Q:group, {
+        "<group_name>":{
+            +id:"some/NT:1.0",  # top level ID
+            +atomic:true,
+            "<field.name>":{
+                +type:"scalar",
+                +channel:"VAL",
+                +id:"another/NT:1.0",
+                +trigger:"*",
+                +putorder:0,
+            },
+            # special case adds time/alarm meta-data fields
+            # at top level
+            "": {+type:"meta", +channel:"VAL"}
+        }
+    })
+}
+
+
+

Mapping +type:

+
    +

  • scalar (default) places an NTScalar or NTScalarArray as a sub-structure. (see NTScalar and NTScalarArray)

    • +
  • +
    plain ignores all meta-data and places only the “value” as a field.

    The field placed will have the type of the value field of the equivalent NTScalar/NTScalarArray as a field.

    +
    +
    +
    • +

  • any places a variant union into which the “value” is stored.

    • +

  • meta places only the “alarm” and “timeStamp” fields of scalar.

    • +

  • structure places only the associated +id. Has no +channel.

    • +

  • proc places no fields. The associated +channel is processed on PUT. +“proc” mappings will almost always set +putorder to control the relative +ordering of record processing.

    • +
+

Mapping +channel:

+

Most mapping +type require a +channel. +The most common record field to map is +channel: "VAL". +When included in an info(Q:group, ..., the +channel must only name a field of the enclosing record. +(eg. +channel:"VAL") +When in a separate JSON file, +channel must be a full PV name, beginning with a record or alias name. +(eg. +channel:"record:name.VAL")

+

Mapping +trigger:

+

Triggers define when and which changes to the constituent field are translated into a subscription update to the group. ++trigger may be set to:

+
    +

  • "" (default) means that changes to the field do not cause a subscription update. (see note below)

    • +

  • "*" causes a subscription update containing the most recent values/meta-data of all group fields.

    • +

  • A comma separated list of field names causes an update with the most recent values of only the listed group fields. +eg. +trigger: "value.A, value.B".

    • +
+

For a new group definition, including records from one or more record processing chains, +the last record in that chain should have a +trigger mapping listing the group fields +updated by records in that chain.

+

In the common case where a group is mapped to records in only one processing chain, +then the last mapped record in that chain should have +trigger: "*".

+
+

Note

+

As a special case. A group with no +trigger mappings at all will function as if every mapping +includes a +trigger mapping for itself. +This is done so that such a situation does not cause confusion be posting no monitor updates at all. +However, this situation will almost never give desired behaviour as changes to records which +could otherwise be atomic will be split into multiple subscription updates.

+
+

Mapping +putorder:

+

+putorder must be set for a field to be writable through a group PV. +When more than one mapping has an order defined, the numeric value is used to define +the order in which the associated records are processed (in increasing order).

+

Additionally, the values of +putorder also control the order of fields in the group PV definition. +This control is necessary only in limited cases, such as the NTTable specification, +where the iteration order of fields must match the order of the labels array.

+
+
+

Understanding Groups

+
+

NTTable Group Example

+

One motivating use case for groups involves moving tabular data, encoded as “NTTable”. +The overall goal of the TST:Tbl group PV is to take what would be a series of +discrete, non-atomic, network operations

+
caput -a TST:A X 1 2 3
+caput -a TST:B X 5 6 7
+caput TST:Save.PROC 1
+
+
+

can instead be a single, atomic, network operation

+
pvput TST:Tbl value.A='[1,2,3]' value.B='[5,6,7]'
+
+
+

A subscriber sees:

+
pvmonitor TST:Tbl
+TST:Tbl <undefined>               INVALID DRIVER UDF
+"Label A" "Label B"
+TST:Tbl 2023-08-30 09:55:19.999
+"Label A" "Label B"
+        1         5
+        2         6
+        3         7
+
+
+

This effect is achieved by mapping a table of two columns (“A” and “B”) onto two aao records. +With a third record to take some action once both are updated.

+

The following is meant to illustrate the mapping between the individual records, +and the fields of the group PV TST:Tbl.

+

On the left hand side are the contents of a file test.db, +and on the right the output of pvget TST:Tbl.

+
_images/nt_table1.svg

Here the TST:Labels_ record contributes two mappings to the TST:Tbl Group. +(a record might contribute mappings to more than one group)

+

This +id mapping contributes only the static type label string. +it could be attached to any of the four records, and is arbitrarily placed with this one.

+

Necessarily, the label mappings provides the column labels of the “NTTable” definition. +So the record TST:Labels_ field VAL is mapped into TST:Tbl as labels. +With +type: "plain", this appears as a string array (“string[]”).

+
_images/nt_table2.svg

The TST:A record contributes only a value.A field. +With +type: "plain", this appears as a string array (“double[]”).

+

The value.A mapping also sets +putorder: 0, which is necessary to allow this group member +field to be changed through a PUT to the Group PV. +The numeric value controls the order in which records effected by a PUT are processed. +Processing occurs in order of increasing +putorder.

+
_images/nt_table3.svg

The TST:B record contributes both a value.B field in the same manner as the A field/column.

+

Additionally, it contributes a special "" field with +type: "meta". +This exposes the TST:B.VAL timestamp and alarm meta-data as the sub-structure +fields alarm and timeStamp.

+
_images/nt_table4.svg

The final record TST:Save does not contribute any data fields. +Instead it contributes a special +type: "proc" mapping. +Also, it contributes a +trigger mapping so that processing this record will +trigger a subscription/monitor update to all (changed) fields.

+

Note, the field name _save only needs to be locally unique within the group, +but is otherwise ignored.

+
+

Database Listing

+

Loading the following with.

+
dbLoadRecords("table.db", "N=TST:,LBL1=Label A,LBL2=Label B,PO1=0,PO2=1")
+
+
+
 1
+ 2record(aai, "$(N)Labels_") {
+ 3    field(FTVL, "STRING")
+ 4    field(NELM, "2")
+ 5    field(INP , {const:["$(LBL1)", "$(LBL2)"]})
+ 6    info(Q:group, {
+ 7        "$(N)Tbl":{
+ 8            +id:"epics:nt/NTTable:1.0",
+ 9            "labels":{+type:"plain", +channel:"VAL"}
+10        }
+11    })
+12    field(TPRO, "1")
+13}
+14
+15record(aao, "$(N)A") {
+16    field(FTVL, "DOUBLE")
+17    field(NELM, "10")
+18    info(Q:group, {
+19        "$(N)Tbl":{
+20            "value.A":{+type:"plain", +channel:"VAL", +putorder:$(PO1)}
+21        }
+22    })
+23    field(TPRO, "1")
+24}
+25
+26record(aao, "$(N)B") {
+27    field(FTVL, "DOUBLE")
+28    field(NELM, "10")
+29    info(Q:group, {
+30        "$(N)Tbl":{
+31            "":{+type:"meta", +channel:"VAL"},
+32            "value.B":{+type:"plain", +channel:"VAL", +putorder:$(PO2)}
+33        }
+34    })
+35    field(TPRO, "1")
+36}
+37
+38record(longout, "$(N)Save") {
+39    field(MDEL, "-1") # ensure we always trigger group monitor
+40    field(TPRO, "1")
+41    info(Q:group, {
+42        "$(N)Tbl":{
+43            "_save":{+type:"proc",
+44                     +channel:"VAL",
+45                     +putorder:2,
+46                     +trigger:"*"}
+47        }
+48    })
+49}
+
+
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/qsrv2-schema-0.json b/qsrv2-schema-0.json new file mode 100644 index 000000000..f8d737f22 --- /dev/null +++ b/qsrv2-schema-0.json @@ -0,0 +1,30 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "$id": "https://epics-base.github.io/pvxs/qsrv2-schema-0.json", + "title": "QSRV2 group schema", + "type": "object", + "additionalProperties": { + "$comment": "Group", + "type": "object", + "properties": { + "+id": { "type": "string" }, + "+atomic": { "type": "boolean", "default": true } + }, + "additionalProperties": { + "$comment": "Group field", + "type": "object", + "properties": { + "+id": { "type": "string" }, + "+type": { + "type": "string", + "enum": ["any", "meta", "plain", "proc", "scalar", "structure"], + "default": "scalar" + }, + "+channel": { "type": "string" }, + "+putorder": { "type": "integer", "default": 0 }, + "+trigger": { "type": "string" , "default": "" } + }, + "additionalProperties": false + } + } +} diff --git a/releasenotes.html b/releasenotes.html new file mode 100644 index 000000000..134f11025 --- /dev/null +++ b/releasenotes.html @@ -0,0 +1,569 @@ + + + + + + + + + Release Notes — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Release Notes

+
+

1.3.2 (UNRELEASED)

+
    +

  • client: Avoid FD leak on failed connect()

    • +

  • Correctly set TCP_NODELAY on winsock

    • +

  • ioc: Workaround asTrapWrite clobbering dbChannel

    • +

  • ioc: ACF fix write permit when groups are present

    • +
+
+
+

1.3.1 (Dec 2023)

+
    +

  • Install pvxsIoc.dbd with the correct name in python build.

    • +

  • No change to Makefile build.

    • +
+
+
+

1.3.0 (Dec 2023)

+
    +

  • Set TCP_NODELAY on client and server sockets.

    • +

  • Disambiguate Size from Selector when decoding messages.

    • +
  • +
    QSRV
      +

    • QSRV 2 now considered “feature complete”.

      • +

    • Avoid sending 0 precision w/ integer value.

      • +

    • Add PVA Links.

      • +
    +
    +
    +
    • +
+
+
+

1.2.4 (Oct 2023)

+
    +

  • data: Relax when assigning struct[] or union[] of similar types.

    • +

  • client: avoid assert() with invalid forced server name.

    • +

  • client: propagate exception during early op. setup.

    • +

  • client: GET yield complete updates after first.

    • +

  • server: Ensure that variables bound into operation callback std::function<> are +released promptly when that operation is ended.

    • +

  • server: relax post() after finish(). Return false instead of throwing std::logic_error.

    • +
  • +
    ioc: ensure db_cancel_event() before ~MonitorControlOp
    +
    +
    +
    • +

  • ioc: Fix typo preventing processing of DBR_STRING fields.

    • +

  • ioc: fix group put always dbProcess.

    • +

  • ioc: fix block=true to DBF_ENUM.

    • +

  • ioc: actually require +putorder to PUT.

    • +

  • ioc: group put w/o effect is an error.

    • +

  • ioc: accept record._options.process as bool

    • +

  • ioc: group avoid post() empty events

    • +
+
+
+

1.2.3 (Sept 2023)

+
    +

  • Add $PVXS_ENABLE_IPV6 environment variable. Set PVXS_ENABLE_IPV6=NO to disable usage of IPv6.

    • +
  • +
    IOC: A warning is printed if a group definition includes no +trigger mappings.

    This is likely a mis-configuration by omission which will produce more monitor updates than expected.

    +
    +
    +
    • +

  • pvxs::server::ConnectOp::error() no longer blocks.

    • +

  • Add pvxs::target_information().

    • +

  • IOC: fill in display.precision.

    • +

  • Add Understanding Groups section.

    • +

  • Add pvxs::nt::NTTable helper.

    • +

  • Clarify some exception messages.

    • +

  • Add pvxs::ioc::testPrepare.

    • +
+
+
+

1.2.2 (June 2023)

+
    +

  • IOC: improve long string detection.

    • +

  • Changes to Tree output format for Value.

    • +

  • Applied various bug fixes for issued detected by static analysis. All believed to be minor.

    • +
+
+
+

1.2.1 (June 2023)

+
    +

  • Quiet erroneous MONITOR exceeds window size warning message on finish().

    • +

  • Fix incomplete py build

    • +

  • Add Python 3.11 builds (Alex Wells)

    • +
+
+
+

1.2.0 (May 2023)

+
    +

  • server: fix default monitor queueSize to 4

    • +

  • improve localhost multicast forwarding

    • +

  • server: bind both wildcard for UDP

    • +

  • update bundled libevent

    • +

  • Add pvxs::nt::NTScalar::form.

    • +

  • NTEnum add display.description

    • +

  • client: schedule initial search use separate event from the generic work queue. (Thomas Ives)

    • +

  • client: re-define the meaning of poke()

    • +

  • server: fix stats(reset=true)

    • +

  • prevent simple Any self-assignment

    • +

  • Value::copyIn() (also from() and operator =) add Array -> Array w/ implied alloc+convert

    • +

  • client: fix batch pop() of exception

    • +

  • fix monitor pipeline and finish()

    • +

  • server: add MonitorStat::nSquash

    • +

  • Add feature preview of QSRV 2 IOC server functionality.

    • +
+
+
+

1.1.4 (April 2023)

+
    +

  • client: fix delta sync of Compound. Regression in 1.1.0.

    • +

  • Add wrappers for some libevent socket manipulations as Expert APIs.

    • +

  • Improve diff output of testStrEq.

    • +

  • msvc build compat. /wd* compiler flags sometimes interpreted as paths.

    • +
+
+
+

1.1.3 (Mar 2023)

+
    +

  • Fix pvxs::Value::nmembers() which erroneously returned 0 for StructA and UnionA.

    • +

  • Fix pvxs::Value::unmark() where parent=true caused corruption.

    • +

  • Change to “magic” automatic Union member selection during assignment.

    • +

  • Fix pvxs::shared_array::convertTo() converting Float64 to Float32 caused corruption.

    • +

  • Fix TypeDef(const Value& val) for Union/UnionA/StructA

    • +

  • Fix unsigned handling

    • +

  • server: rework cleanup of connection, channel, and operation

    • +
+
+
+

1.1.2 (Feb 2023)

+ +
+
+

1.1.1 (Dec 2022)

+
    +

  • Fix protocol decoding error with TypeStore.

    • +
+
+
+

1.1.0 (Nov 2022)

+ +
+
+

1.0.1 (Oct 2022)

+
    +

  • Fix c++17 compilation issue

    • +

  • Allow TypeDef to append StructA and UnionA

    • +

  • Reduce “non-existent IOID” noise

    • +

  • Fix CMD_MESSAGE handling

    • +

  • Fix locking of client monitor during pop()

    • +

  • Calculate buffer sizes in terms of OS socket buffer limit

    • +

  • Fix low water mark calculation

    • +

  • Fix Timer ownership (expert API)

    • +

  • Avoid assert() when client asked to search for PV names longer than 1400 bytes.

    • +
+
+
+

1.0.0 (Sept 2022)

+
    +

  • Add pvxs::client::ConnectBuilder::server

    • +

  • Add hold-off timer when reconnecting to a specific server.

    • +

  • Fix missing closing quote when printing a String in tree format.

    • +
+
+
+

0.3.1 (June 2022)

+
    +

  • Fix ifaddrs::ifa_addr can be NULL

    • +

  • Limit beacon tracking by size as well as time

    • +
+
+
+

0.3.0 (May 2022)

+
    +

  • Fix protocol incompatibility with Big Endian servers.

    • +

  • Add support for IPv4 multicast and IPv6 uni/multicast for UDP. And IPv6 unicast for TCP. +See Address Spec. for entries which may now appear in EPICS_PVA*_ADDR_LIST.

    • +

  • PVXS now attempts to fanout unicast searches through the loopback interface, and +to handle CMD_ORIGIN_TAG messages (aka. the local multicast hack).

    • +

  • Add pvxs::client::Context::discover() to enumerate and track PVA Servers.

    • +

  • pvxlist add “continuous” mode. (eg. pvxlist -v -w 0) +To immediately Discover new servers, then continue listening for Beacons to detect +as server go up and down (like casw). +Also, to be gentler on your network, add -P to skip initial Discovery ping, +and only listen for Beacons.

    • +
+
+
+

0.2.2 (Jan 2022)

+
    +

  • No functional change to libraries.

    • +

  • Updates to python packaging.

    • +
+
+
+

0.2.1 (Oct 2021)

+
    +

  • Bug fixes

    • +
+
+
+
+
    +

  • Changes

    • +
+
+
    +

  • Ignore beacons with protocol field other than “tcp”. Forward compatibility.

    • +

  • Limit packet hex dumps to 64 bytes.

    • +

  • testStrMatch() now specified POSIX regular expression syntax.

    • +

  • Client operations builders rawRequest(Value()) is now a no-op. +Previously produced a non-nonsensical empty request.

    • +
+
+
    +

  • Additions

    • +
+
+
+
+
+

0.2.0 (July 2021)

+
    +

  • Bug fixes

    • +
+
+
    +

  • Resolve ambiguity between Value::as(T&) and Value::as(FN&&) causing issue with GCC 4.8.

    • +

  • Fix encoding of (Sub)Struct w/ valid set.

    • +

  • Fix locking issue with client tracking of server beacons.

    • +

  • Fix binding to specific interface addresses.

    • +
+
+
    +

  • Changes

    • +
+
+
    +

  • To simplify usage in situations with complex threading, many client methods avoid unnecessary +synchronization with the client worker thread. +Cancellation still synchronizes by default, but this may now be controlled with +the new syncCancel() Builder methods. cf. pvxs::client::detail::CommonBuilder::syncCancel().

    • +

  • Client Op Builder server() method now implemented.

    • +

  • Client channel cache now periodically prunes unused Channels automatically.

    • +
+
+
    +

  • Additions

    • +
+
+
+
+
+
+

0.1.5 (May 2021)

+
    +

  • Bug Fixes

    • +
+
+
+
+
    +

  • Changes

    • +
+
+
    +

  • Default logger level changed from Err to Warn.

    • +

  • Server warns when falling back from requested TCP port.

    • +

  • Public headers include <iosfwd> instead of <ostream>.

    • +
+
+
    +

  • Additions

    • +
+
+
+
+
+

0.1.4 (APR 2021)

+
    +

  • Bug Fixes

    • +
+
+
    +

  • Fix potential locking issue monitor queue

    • +

  • Fix potential locking issue in Shared PV with concurrent open()/close() vs. post()

    • +
+
+
    +

  • Additions

    • +
+
+
+
+
+

0.1.3 (FEB 2021)

+
    +

  • Bug Fixes

    • +
+
+
    +

  • Fix regression from 0.1.2 causing possible crash on targets defining SO_RXQ_OVFL (eg. Linux).

    • +
+
+
+
+

0.1.2 (FEB 2021)

+
    +

  • Bug Fixes

    • +
+
+
    +

  • Fix TCP connection “stall” (incorrect deferred read).

    • +
+
+
    +

  • Changes

    • +
+
+
    +

  • Raise UDP search reply processing limit.

    • +

  • Try not to fragment UDP search packets.

    • +

  • mailbox example can serve more than one PV.

    • +

  • Indent printed field=value in delta output mode.

    • +
+
+
+
+

0.1.1 (Jan 2021)

+
    +

  • Bug Fixes

    • +
+
+
    +

  • Fix decoding of “null” string. Addresses interoperability with pvAccessJava.

    • +

  • Increase inactivity timeout for TCP connections from 30 to 40 seconds. Also for interoperability with pvAccessJava.

    • +

  • Client search requests incorrectly set Server direction bit. (existing servers don’t enforce this)

    • +

  • Improved handling of errors resulting from pvRequest processing. eg. field selection which doesn’t select any fields.

    • +
+
+
    +

  • Added Features

    • +
+
+
    +

  • Added PVXS_ABI_VERSION et al. to pvxs/version.h

    • +

  • Add testThrowsMatch and testStrMatch to pvxs/unitttest.h

    • +
+
+
    +

  • Changes

    • +
+
+
    +

  • Changed name of automatic Sources "builtin" and "server" to "__builtin" and "__server". +Document that Source names beginning with __ are reserved.

    • +
+
+
+
+

0.1.0 (Dec 2020)

+
+
    +

  • Initial Release

    • +
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 000000000..6f9e973a4 --- /dev/null +++ b/search.html @@ -0,0 +1,139 @@ + + + + + + + + Search — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + +
+ + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 000000000..d85b4c397 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["building", "cli", "client", "details", "example", "index", "ioc", "netconfig", "nt", "ntscalar", "overview", "pvalink", "qgroup", "releasenotes", "server", "sharedpv", "source", "typedef", "util", "value"], "filenames": ["building.rst", "cli.rst", "client.rst", "details.rst", "example.rst", "index.rst", "ioc.rst", "netconfig.rst", "nt.rst", "ntscalar.rst", "overview.rst", "pvalink.rst", "qgroup.rst", "releasenotes.rst", "server.rst", "sharedpv.rst", "source.rst", "typedef.rst", "util.rst", "value.rst"], "titles": ["Building from Source", "Command Line Tools", "Client API", "Details", "Examples", "PVXS client/server for PVA Protocol", "IOC Integration", "PVA Network Configuration", "Common Type Definitions", "NTScalar and NTScalarArray", "Overview", "PVA Links", "QSRV Groups", "Release Notes", "Server API", "SharedPV and StaticSource", "Data Source", "Defining Custom Types", "Misc", "Value Container API"], "terms": {"begin": [0, 2, 6, 7, 10, 12, 13, 14, 15, 16, 18, 19], "fetch": [0, 2, 4, 10, 14, 15], "all": [0, 1, 2, 3, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "need": [0, 1, 2, 5, 6, 7, 10, 12, 16, 18], "git": [0, 3], "clone": [0, 19], "recurs": 0, "http": [0, 3, 4, 5, 10, 13], "github": [0, 3, 4, 5, 13], "com": [0, 3, 4, 5, 13], "epic": [0, 3, 4, 5, 8, 9, 12, 13, 18], "base": [0, 2, 3, 4, 5, 6, 8, 10, 13, 14, 16, 17, 18, 19], "branch": 0, "7": [0, 6, 8, 12], "0": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15, 16, 17, 18, 19], "prepar": [0, 2, 16], "tree": [0, 13, 19], "locat": 0, "cat": [0, 3], "eof": 0, "configur": [0, 1, 4, 5, 6, 8, 10, 13, 18, 19], "releas": [0, 2, 5, 8, 14, 16, 18], "local": [0, 2, 3, 4, 6, 7, 10, 11, 12, 13, 14, 16, 19], "epics_bas": 0, "top": [0, 4, 10, 11, 12, 15, 19], "make": [0, 3, 4, 5, 6, 18, 19], "c": [0, 1, 3, 4, 5, 6, 9, 10, 13, 18, 19], "altern": [0, 2, 3], "instal": [0, 2, 4, 13], "libev": [0, 3, 5, 13, 18], "2": [0, 2, 4, 5, 7, 8, 9, 11, 12, 14, 16, 18, 19], "On": [0, 1, 12, 15, 16], "rhel7": 0, "later": [0, 6, 10, 14, 15, 16], "yum": 0, "devel": 0, "rhel6": 0, "earlier": 0, "debian": 0, "ubuntu": 0, "apt": 0, "get": [0, 5, 10, 13, 16], "dev": 0, "To": [0, 3, 7, 10, 11, 13, 18], "requir": [0, 2, 4, 9, 10, 11, 12, 13, 19], "cmake": [0, 5], "bundl": [0, 5, 13], "impli": [0, 2, 13, 16, 19], "epics_host_arch": 0, "For": [0, 2, 10, 11, 12, 14, 16, 17, 19], "addit": [0, 2, 3, 6, 8, 13, 17, 18], "arch": [0, 3], "eg": [0, 1, 2, 3, 4, 6, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "linux": [0, 3, 13], "x86_64": [0, 3], "debug": [0, 1, 4, 18], "final": [0, 4, 12], "It": [0, 2, 3, 6, 10, 15, 17, 18], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19], "recommend": [0, 2, 3, 6, 14, 18], "automat": [0, 2, 3, 6, 7, 10, 13, 14], "unittest": [0, 18], "when": [0, 2, 3, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "new": [0, 2, 3, 7, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "you": [0, 18], "version": [0, 2, 3, 4, 6, 13, 14, 18, 19], "host": [0, 1, 2, 3, 6, 7, 14], "runtest": [0, 3], "The": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19], "mai": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19], "built": [0, 3, 4, 6, 10], "some": [0, 2, 3, 4, 6, 9, 10, 12, 13, 16, 18, 19], "target": [0, 3, 6, 11, 13, 16], "current": [0, 1, 2, 4, 6, 8, 10, 11, 13, 14, 16, 18], "onli": [0, 2, 3, 5, 6, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19], "mingw": 0, "window": [0, 6, 13, 16], "x64": 0, "an": [0, 2, 3, 4, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "ioc": [0, 1, 5, 13], "us": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "makefil": [0, 13], "straightforward": 0, "add": [0, 1, 2, 3, 4, 6, 10, 11, 12, 13, 14, 15, 16, 18], "file": [0, 3, 4, 6, 11, 12], "path": [0, 3, 10, 13], "Then": [0, 2], "pvxsioc": [0, 6, 13, 18], "librari": [0, 3, 5, 6, 8, 13, 18], "depend": [0, 2, 5, 6, 10, 16, 19], "support": [0, 2, 3, 6, 9, 10, 13], "modul": [0, 1, 3, 5, 6], "prod_ioc": 0, "myioc": 0, "myioc_dbd": 0, "dbd": [0, 6, 11, 13, 18], "myioc_lib": 0, "epics_base_ioc_lib": 0, "should": [0, 1, 2, 3, 6, 8, 10, 12, 14, 16, 18, 19], "can": [0, 1, 2, 3, 4, 7, 8, 9, 10, 11, 12, 13, 14, 16, 17, 19], "omit": [0, 18], "standalon": 0, "gui": [0, 3], "client": [0, 1, 3, 6, 7, 8, 9, 10, 13, 14, 15, 16, 19], "execut": [0, 1, 2, 7, 10, 13, 15, 16], "myapp": [0, 18], "myapp_lib": 0, "ad": [0, 2, 5, 12, 13, 14, 15, 16, 17, 18], "link": [0, 5, 13], "those": [0, 3, 16, 19], "interest": [0, 17], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "accomplish": [0, 2, 10, 19], "logic": 0, "found": [0, 3, 4], "cfg": 0, "config_pvxs_modul": 0, "A": [1, 2, 3, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "basic": [1, 5, 14], "set": [1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 18], "ar": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "provid": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 18, 19], "facilit": 1, "test": [1, 3, 5, 12, 14, 15, 19], "develop": [1, 3], "end": [1, 2, 13, 16, 19], "user": [1, 2, 3, 5, 6, 8, 10, 13, 16], "prefer": [1, 7, 14, 16, 18], "cli": [1, 3, 5, 14, 18], "from": [1, 2, 3, 4, 5, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17, 19], "pvaccesscpp": [1, 2, 5, 14], "dai": 1, "pvxcall": 1, "analog": [1, 10, 19], "pvcall": 1, "pvxget": [1, 3, 6, 10], "pvget": [1, 6, 12], "pvxinfo": [1, 3, 18], "pvinfo": 1, "pvxmonitor": [1, 10], "pvmonitor": [1, 12], "m": [1, 2, 11, 17, 18], "pvxput": [1, 10], "pvput": [1, 12], "pvxvct": 1, "udp": [1, 2, 3, 7, 13, 14], "search": [1, 2, 3, 5, 7, 13, 16], "beacon": [1, 2, 7, 13, 14], "capabl": 1, "listen": [1, 2, 3, 13, 14], "pva": [1, 2, 3, 6, 10, 12, 13, 14, 17], "server": [1, 2, 3, 7, 10, 11, 12, 13, 15, 16, 19], "togeth": [1, 11, 12], "thei": [1, 4], "investig": 1, "commun": [1, 14, 19], "issu": [1, 3, 5, 11, 13, 16, 18], "otherwis": [1, 11, 12, 16, 18, 19], "run": [1, 2, 3, 4, 5, 6, 10, 14, 15, 16, 18], "follow": [1, 2, 3, 7, 10, 12, 14, 15, 19], "p": [1, 2, 13, 18], "my": [1, 4, 6], "random": [1, 14, 19], "pvname": [1, 2, 4], "while": [1, 2, 3, 8, 10, 11, 18], "switch": [1, 17], "where": [1, 2, 3, 10, 12, 13, 19], "resid": 1, "If": [1, 2, 3, 9, 11, 14, 16, 18, 19], "goe": 1, "well": [1, 2, 3, 6, 10, 11, 13, 17, 18, 19], "process": [1, 2, 3, 4, 6, 7, 10, 11, 12, 13, 14, 18], "print": [1, 4, 6, 13, 16, 18, 19], "sever": [1, 2, 4, 6, 8, 9, 10, 11, 12, 13, 17, 19], "request": [1, 3, 5, 6, 10, 11, 13, 14, 16, 19], "receiv": [1, 2, 3, 7, 10, 13, 16], "2020": [1, 5], "04": 1, "09t19": 1, "37": 1, "01": 1, "146272170": 1, "info": [1, 5, 6, 12, 18], "192": [1, 7], "168": [1, 7], "1": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19], "47357": 1, "146442772": 1, "note": [1, 2, 5, 6, 8, 12, 17, 18], "doe": [1, 3, 6, 12, 14, 16, 18, 19], "epics_pva": [1, 2, 3, 6, 7, 13, 14], "environ": [1, 2, 3, 4, 5, 6, 13, 14, 18], "variabl": [1, 2, 3, 4, 5, 6, 10, 13, 14, 15, 16, 18], "default": [1, 2, 4, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "5076": [1, 2, 7, 14], "site": [1, 3, 8, 10], "non": [1, 3, 12, 13, 15, 17, 18, 19], "port": [1, 2, 3, 7, 13, 14], "b": [1, 2, 12, 18, 19], "seen": [1, 10, 16], "firewal": [1, 3], "d": [1, 3, 9, 15, 18, 19], "real": [1, 17, 19], "pv": [1, 2, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15, 16], "name": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "output": [1, 6, 12, 13, 16, 18, 19], "veri": [1, 10, 17], "verbos": 1, "look": [1, 7, 10, 11, 18], "like": [1, 2, 3, 11, 13, 14, 16, 18, 19], "44": 1, "46": 1, "064937960": 1, "pvx": [1, 2, 3, 4, 6, 7, 8, 9, 13, 14, 15, 16, 17, 18, 19], "io": [1, 5], "rx": 1, "53": 1, "064947396": 1, "repli": [1, 4, 13, 15, 16], "065151400": 1, "connect": [1, 3, 5, 6, 7, 10, 11, 13, 14, 15, 16], "5075": [1, 2, 3, 14], "065200101": 1, "067255960": 1, "accept": [1, 2, 13, 16], "auth": 1, "repeat": [1, 7, 8, 18], "place": [1, 9, 12, 19], "subsequ": [1, 3, 8, 15, 18], "error": [1, 2, 4, 10, 13, 15, 16, 19], "messag": [1, 2, 3, 4, 7, 8, 9, 13, 14, 18], "see": [1, 2, 3, 4, 5, 6, 7, 9, 12, 13, 18, 19], "report": [1, 5, 6, 18], "bug": [1, 5, 6, 13, 18], "attach": [1, 2, 6, 12, 15, 16], "context": [2, 3, 4, 7, 8, 9, 10, 12, 13, 14, 15, 18], "repres": [2, 8, 9, 14, 19], "protocol": [2, 3, 7, 10, 13, 14, 16, 17], "includ": [2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "h": [2, 3, 4, 6, 8, 13, 14, 15, 16, 17, 18, 19], "namespac": [2, 4, 6, 8, 9, 10, 14, 15, 16, 17, 18, 19], "start": [2, 3, 4, 6, 8, 14, 16], "point": [2, 3, 14, 19], "creat": [2, 4, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19], "epics_pva_": [2, 4, 7], "fromenv": [2, 4, 13, 14, 15], "epics_pva_addr_list": [2, 7, 14], "list": [2, 4, 6, 7, 8, 13, 14, 16, 17, 19], "destin": [2, 7], "address": [2, 4, 5, 6, 10, 13, 14, 15, 16, 19], "which": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "sent": [2, 3, 4, 7, 10, 14, 16], "contain": [2, 4, 5, 6, 8, 10, 12, 14], "unicast": [2, 7, 13, 14], "broadcast": [2, 7, 10, 14], "epics_pva_auto_addr_list": [2, 7, 14], "ye": [2, 6, 14], "implicitli": [2, 4, 16], "append": [2, 8, 9, 13, 17, 18], "unset": [2, 14], "epics_pva_name_serv": [2, 7], "tcp": [2, 3, 7, 13, 14], "socket": [2, 3, 13, 16], "epics_pva_broadcast_port": [2, 7, 14], "epics_pva_conn_tmo": [2, 7, 14], "inact": [2, 13, 14], "timeout": [2, 4, 13, 14], "compat": [2, 3, 5, 12, 13, 14, 18, 19], "multipli": [2, 14], "4": [2, 3, 5, 8, 11, 14, 18, 19], "3": [2, 5, 6, 7, 8, 11, 12, 14, 16, 18, 19], "appli": [2, 3, 6, 11, 13, 14, 17, 18], "so": [2, 3, 5, 6, 10, 12, 14, 16], "valu": [2, 3, 4, 5, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18], "30": [2, 3, 12, 13, 14], "40": [2, 13, 14], "second": [2, 3, 4, 8, 13, 14, 19], "prior": [2, 6, 14, 18, 19], "wa": [2, 10, 14, 16, 18], "ignor": [2, 9, 11, 12, 13, 14], "ipv4": [2, 7, 13, 14, 16], "multicast": [2, 3, 7, 13, 14], "ipv6": [2, 7, 13, 14], "uni": [2, 13, 14], "ctxt": [2, 4, 10], "programmat": 2, "explicitli": [2, 7, 14, 16, 18, 19], "fill": [2, 4, 10, 13, 16, 19], "config": [2, 4, 13, 14, 15], "instanc": [2, 3, 6, 10, 14, 15, 16, 18, 19], "entri": [2, 6, 7, 13, 14, 16], "network": [2, 3, 4, 5, 10, 11, 12, 13, 14, 18], "call": [2, 3, 6, 7, 8, 10, 14, 15, 16, 18, 19], "one": [2, 3, 4, 7, 10, 12, 13, 14, 16, 18, 19], "method": [2, 3, 8, 10, 13, 14, 15, 16, 18, 19], "each": [2, 3, 7, 8, 10, 11, 14, 15, 16, 17, 18], "return": [2, 4, 6, 8, 10, 13, 15, 16, 18, 19], "builder": [2, 4, 8, 13], "object": [2, 8, 10, 18, 19], "what": [2, 3, 5, 9, 12, 18], "effect": [2, 3, 4, 6, 12, 13, 14, 15, 19], "argument": [2, 14, 16, 18, 19], "class": [2, 8, 10, 14, 16, 17, 18, 19], "independ": 2, "typic": [2, 8], "build": [2, 4, 5, 8, 9, 10, 13, 14, 15, 17, 18, 19], "from_env": 2, "public": [2, 3, 8, 9, 10, 13, 14, 15, 16, 17, 18, 19], "function": [2, 5, 6, 8, 9, 12, 13, 14, 15, 16, 17, 18, 19], "constexpr": [2, 14, 17, 19], "empti": [2, 4, 10, 11, 13, 14, 16, 17, 18, 19], "dummi": [2, 14, 19], "explicit": [2, 7, 10, 14, 16, 17, 18, 19], "const": [2, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "alloc": [2, 4, 13, 14, 18, 19], "conveni": [2, 3, 14, 19], "shorthand": [2, 14, 17, 19], "void": [2, 6, 10, 14, 15, 16, 18, 19], "close": [2, 10, 13, 15, 16], "forc": [2, 13, 15, 16], "option": [2, 4, 5, 6, 9, 10, 14, 18, 19], "abort": 2, "interrupt": [2, 13, 14], "progress": [2, 16], "block": [2, 13, 14, 16, 18], "until": [2, 4, 7, 16], "ani": [2, 3, 4, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "callback": [2, 4, 10, 13, 15, 16], "have": [2, 4, 8, 9, 10, 12, 14, 16, 18, 19], "complet": [2, 3, 4, 10, 13, 16, 17, 18], "sinc": [2, 3, 6, 8, 9, 11, 14, 16, 17, 18, 19], "inlin": [2, 8, 9, 14, 16, 17, 18, 19], "getbuild": [2, 10], "std": [2, 4, 6, 9, 10, 13, 14, 15, 16, 17, 18, 19], "string": [2, 6, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19], "present": [2, 4, 10, 13, 15, 16, 18, 19], "simpl": [2, 4, 13, 14, 15, 17], "auto": [2, 4, 8, 9, 14, 15, 16, 17, 18, 19], "exec": [2, 4, 10], "wait": [2, 3, 4, 16, 18], "With": [2, 6, 10, 12, 19], "op": [2, 4, 6, 10, 13, 15, 16], "prototyp": [2, 16], "cout": [2, 4, 10, 18, 19], "store": [2, 4, 12, 16, 19], "detail": [2, 5, 6, 7, 13, 18, 19], "type": [2, 3, 4, 5, 9, 10, 11, 12, 13, 15, 16, 18, 19], "inform": [2, 3, 4, 6, 8, 16, 18, 19], "mark": [2, 4, 8, 10, 13, 19], "field": [2, 4, 5, 6, 8, 11, 12, 13, 16, 17], "putbuild": 2, "chang": [2, 3, 4, 5, 6, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19], "updat": [2, 4, 8, 10, 11, 12, 13, 14, 15, 16, 19], "assign": [2, 4, 8, 13, 19], "certain": [2, 11, 16, 18], "42": [2, 4, 7, 9, 10, 15, 19], "more": [2, 3, 10, 12, 13, 14, 16, 19], "gener": [2, 3, 13, 16, 19], "notif": [2, 10, 15], "putval": 2, "cloneempti": [2, 4, 8, 19], "try": [2, 3, 10, 13, 15, 18], "alwai": [2, 3, 6, 10, 11, 12, 13, 18, 19], "success": [2, 3, 4, 15, 19], "catch": [2, 10], "except": [2, 4, 10, 13, 14, 18, 19], "e": [2, 10, 19], "rpcbuilder": 2, "arg": [2, 18], "stateless": 2, "remot": [2, 10, 16, 19], "procedur": 2, "blah": [2, 17, 18], "5": [2, 4, 5, 8, 12, 19], "other": [2, 3, 6, 8, 9, 10, 13, 14, 16, 18, 19], "exampl": [2, 3, 5, 7, 10, 13, 15, 19], "monitorbuild": 2, "subscript": [2, 10, 11, 12, 13, 15, 16], "mpmcfifo": [2, 13, 18], "shared_ptr": [2, 3, 10, 14, 15, 16, 19], "workqueu": 2, "42u": 2, "sub": [2, 5, 8, 11, 12, 13, 16, 17, 19], "event": [2, 11, 13, 14, 16], "queue": [2, 11, 13, 14, 16, 18], "becom": [2, 10, 15, 19], "avoid": [2, 3, 10, 13, 18, 19], "o": [2, 3, 4, 7, 13, 15, 16, 19], "worker": [2, 13, 16], "deleg": 2, "applic": [2, 3, 5, 6], "push": [2, 18], "shared_from_thi": [2, 13], "pop": [2, 13, 18], "could": [2, 8, 9, 10, 12, 14, 15], "nullptr": [2, 8, 18, 19], "break": [2, 3, 14, 18], "continu": [2, 13], "anoth": [2, 3, 4, 10, 12, 17, 19], "n": [2, 4, 8, 10, 12, 18, 19], "disconnect": [2, 11, 15, 16], "finish": [2, 13, 16], "remoteerror": 2, "cerr": [2, 4], "reschedul": 2, "connectbuild": [2, 13], "manual": [2, 18], "maintain": [2, 3], "channel": [2, 6, 7, 10, 12, 13, 15, 16], "cach": [2, 4, 11, 13], "known": [2, 3, 7], "given": [2, 7, 9, 10, 14, 16], "futur": [2, 16], "onconnect": 2, "ondisconnect": 2, "asynchron": 2, "poll": [2, 10, 16, 18], "di": [2, 11], "state": [2, 6, 8, 10, 11, 18, 19], "discoverbuild": 2, "discov": [2, 13, 16], "fn": [2, 13, 15, 16, 18, 19], "presenc": 2, "absenc": 2, "combin": [2, 10, 11], "period": [2, 7, 13], "ping": [2, 13], "notic": 2, "appear": [2, 3, 12, 13, 19], "disappear": 2, "never": [2, 12, 13, 16, 19], "cancel": [2, 7, 13, 16], "evt": [2, 10, 18], "endl": [2, 4], "pingal": 2, "fals": [2, 11, 13, 14, 15, 16, 18, 19], "10": [2, 7, 12, 15, 19], "hurryup": [2, 3, 7], "prompt": 2, "batch": [2, 13], "vector": [2, 4, 9, 14, 19], "size": [2, 4, 13, 16, 17, 18, 19], "initi": [2, 4, 7, 8, 10, 13, 15, 16, 19], "size_t": [2, 4, 16, 18, 19], "indic": [2, 3, 9, 10, 16], "equival": [2, 5, 6, 7, 8, 9, 11, 12, 17, 18], "detect": [2, 6, 13], "ha": [2, 3, 4, 10, 11, 12, 14, 15, 16, 17, 18], "often": [2, 10], "than": [2, 3, 9, 12, 13, 14, 18], "onc": [2, 7, 8, 12, 15], "per": [2, 11, 14], "static": [2, 6, 12, 13, 14, 15, 18], "requestbuild": 2, "compos": [2, 3, 10, 17, 19], "individu": [2, 6, 12], "pvreq": 2, "record": [2, 6, 8, 11, 12, 13], "pipelin": [2, 11, 13], "true": [2, 4, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "either": [2, 6, 12, 17, 19], "get_field": [2, 16], "practic": [2, 8, 10], "differ": [2, 3, 6, 8, 10, 11, 12, 15, 18, 19], "being": [2, 8, 10, 11, 16, 19], "yield": [2, 13, 16], "commonbuild": [2, 13], "commonbas": 2, "cb": [2, 10], "through": [2, 3, 6, 10, 12, 13, 14, 15, 16, 17, 18, 19], "deliv": [2, 12], "functor": [2, 10, 15, 16], "caller": [2, 16, 18], "must": [2, 4, 6, 7, 10, 12, 14, 16, 17, 18, 19], "keep": [2, 10, 17], "pointer": [2, 10, 19], "In": [2, 3, 6, 7, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19], "form": [2, 3, 4, 6, 7, 9, 13, 18], "pass": [2, 7, 16, 18, 19], "necessari": [2, 3, 6, 10, 11, 12, 15, 16, 18, 19], "mandat": 2, "definit": [2, 3, 4, 5, 6, 9, 11, 12, 13, 14, 17, 19], "addition": [2, 11, 12], "first": [2, 4, 10, 13, 14, 19], "allow": [2, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19], "perform": [2, 10, 18], "index": [2, 5, 9, 10], "lookup": [2, 5, 6, 7, 13, 16], "write": [2, 11, 13], "ntenum": [2, 5, 13, 19], "prbase": 2, "fetchpres": [2, 4], "bool": [2, 9, 13, 14, 15, 16, 17, 18, 19], "f": [2, 3, 19], "previou": 2, "situat": [2, 6, 12, 13, 16], "choic": [2, 8, 9], "But": 2, "undesir": [2, 18], "arrai": [2, 3, 5, 8, 9, 10, 12, 13, 17, 18], "expens": [2, 8], "copi": [2, 3, 15, 16, 18, 19], "overwritten": 2, "templat": [2, 13, 17, 18, 19], "typenam": [2, 17, 18, 19], "t": [2, 3, 4, 10, 13, 16, 18, 19], "val": [2, 4, 6, 10, 12, 13, 15, 16, 17, 18, 19], "util": [2, 3, 5, 10], "paramet": [2, 8, 14, 15, 18, 19], "attempt": [2, 4, 13, 16, 19], "cf": [2, 3, 7, 8, 10, 11, 13, 14], "whether": [2, 3, 6, 10, 14, 15, 19], "fail": [2, 13, 18, 19], "respons": [2, 7, 10], "popul": [2, 7, 8, 14, 17, 19], "actual": [2, 4, 9, 10, 13, 14, 17, 18, 19], "There": [2, 3, 10, 14], "two": [2, 3, 7, 9, 12, 18, 19], "wai": [2, 3, 6, 16, 19], "zero": [2, 10, 14, 15, 16, 18, 19], "These": [2, 16, 19], "singl": [2, 3, 4, 5, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19], "structur": [2, 4, 5, 8, 11, 12, 15, 16, 17, 19], "conform": 2, "nt": [2, 3, 4, 8, 9, 10, 12, 13, 15, 17, 19], "nturi": [2, 5, 19], "convent": 2, "arbitrari": [2, 8, 10, 14], "unalt": 2, "handl": [2, 10, 13, 16, 18], "retain": [2, 10], "hold": [2, 3, 13], "succeed": 2, "struct": [2, 8, 9, 10, 13, 14, 15, 16, 17, 18, 19], "enum": [2, 17, 18, 19], "operation_t": 2, "enumer": [2, 8, 13, 17, 18, 19], "virtual": [2, 3, 5, 16], "pend": 2, "alreadi": [2, 3, 14], "doubl": [2, 4, 12, 14, 15, 19], "As": [2, 6, 12, 13, 14, 18], "via": [2, 6, 7, 10, 14, 16, 19], "time": [2, 3, 4, 7, 8, 9, 10, 11, 12, 13, 15, 16, 18, 19], "throw": [2, 4, 6, 10, 13, 14, 16, 18, 19], "timeouterror": 2, "epicsev": [2, 18], "exceed": 2, "invalid": [2, 8, 11, 12, 13, 17, 18, 19], "without": [2, 7, 11, 16, 17, 19], "holder": 2, "access": [2, 3, 4, 5, 7, 9, 10, 12, 14, 15, 16, 18, 19], "rethrow": 2, "re": [2, 8, 11, 13, 18], "data": [2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 17, 19], "remov": [2, 6, 8, 14, 15, 18, 19], "valid": [2, 8, 10, 13, 17, 19], "thrown": [2, 14, 18, 19], "invok": [2, 16], "again": [2, 3, 4, 10], "invliad": 2, "special": [2, 3, 6, 9, 12, 14, 16, 17, 19], "specif": [2, 3, 6, 8, 10, 12, 13], "mean": [2, 8, 10, 12, 13, 16], "maskconnect": 2, "queu": 2, "maskdisconnect": 2, "date": 2, "normal": 2, "aspect": [2, 3, 19], "select": [2, 3, 8, 11, 13, 16, 19], "fifo": [2, 18], "submit": 2, "subscrib": [2, 4, 10, 11, 12, 15, 16], "activ": [2, 16, 18], "paus": [2, 16], "ask": [2, 13], "stop": [2, 6, 14, 16], "send": [2, 4, 7, 8, 11, 13, 15, 16], "resum": [2, 16], "de": 2, "con": 2, "side": [2, 10, 12, 16], "signal": [2, 9, 13, 16, 18], "failur": 2, "stat": [2, 13, 16], "subscriptionstat": 2, "reset": [2, 13, 16, 18, 19], "statist": [2, 16], "strong": [2, 14, 19], "intern": [2, 10, 13, 14, 15, 16, 18], "refer": [2, 3, 6, 10, 13, 14, 15, 16, 19], "prevent": [2, 3, 6, 11, 13], "implicit": [2, 19], "last": [2, 12, 16, 19], "now": [2, 4, 13, 18, 19], "them": [2, 8, 16], "quickli": 2, "handler": [2, 4, 15, 16, 18], "synccancel": [2, 13], "control": [2, 5, 6, 9, 10, 11, 12, 13, 16, 19], "synchron": [2, 13], "safe": [2, 9, 10, 16, 18, 19], "momentari": 2, "statu": [2, 3, 4, 8, 9, 10, 16, 18], "howev": [2, 6, 12, 15, 16, 17, 19], "guarante": [2, 16, 18], "relat": [2, 3, 9, 10, 11, 16, 17], "prioriti": [2, 14], "concurr": [2, 13, 16, 18], "also": [2, 3, 6, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19], "code": [2, 3, 8, 10, 13, 16, 17, 18, 19], "do": [2, 3, 4, 9, 12, 14, 16, 18, 19], "unnecessari": [2, 13], "work": [2, 3, 10, 13, 17, 18], "within": [2, 3, 9, 10, 12, 18, 19], "directli": [2, 14, 17], "indirectli": [2, 6], "treat": [2, 14], "": [2, 3, 7, 12, 15, 18, 19], "thu": 2, "captur": [2, 5, 16, 18], "therefor": [2, 16], "order": [2, 7, 10, 11, 12, 14, 16, 17], "resourc": [2, 18], "leak": [2, 13, 18], "advis": 2, "consid": [2, 3, 6, 8, 10, 11, 13, 19], "particip": 2, "loop": [2, 16, 18], "between": [2, 3, 7, 10, 12, 13, 17, 18, 19], "mystruct": 2, "danger": 2, "myptr": 2, "make_shar": 2, "broken": 2, "null": [2, 9, 10, 11, 13, 16, 17, 18, 19], "strongli": 2, "unexpect": 2, "condit": [2, 3, 8, 13, 16, 18], "easili": [2, 3], "lead": 2, "quit": 2, "difficult": 2, "isol": [2, 14], "possibl": [2, 6, 9, 10, 13, 17, 18, 19], "weak_ptr": 2, "take": [2, 3, 12, 16, 18], "modifi": [2, 10, 11, 13, 16], "qualifi": [2, 19], "convention": [2, 10], "done": [2, 4, 6, 11, 12], "mask": [2, 10, 16], "limit": [2, 9, 12, 13, 14, 16, 17, 18, 19], "secondli": 2, "specifi": [2, 3, 10, 13], "three": [2, 6, 10, 19], "expos": [2, 6, 12], "textual": 2, "pars": [2, 14], "approach": [2, 10], "intermix": 2, "fallback": [2, 7, 19], "rawrequest": [2, 13], "extern": [2, 6], "assembl": 2, "modif": [2, 3], "subbuild": 2, "common": [2, 4, 5, 9, 10, 12, 14, 19], "fld": [2, 10, 19], "blob": [2, 4, 16], "effici": 2, "kei": [2, 3, 11, 12, 14, 18, 19], "queuesiz": [2, 13], "posit": [2, 7, 18], "integ": [2, 9, 13, 14, 17, 18, 19], "passiv": [2, 11], "expr": [2, 18], "entiti": 2, "separ": [2, 3, 6, 10, 12, 13, 14], "space": [2, 3, 14], "r": [2, 18], "raw": [2, 3, 16, 19], "parser": 2, "behind": 2, "understand": [2, 6, 13, 14, 18], "grammar": 2, "field_nam": 2, "field_list": 2, "option_list": 2, "alarm": [2, 4, 8, 9, 10, 11, 12, 13, 17, 19], "applyenv": [2, 14], "defin": [2, 4, 5, 6, 9, 10, 12, 13, 14, 15, 18, 19], "applydef": [2, 14], "defs_t": [2, 14], "def": [2, 8, 9, 14, 17], "updatedef": [2, 14], "extract": [2, 10, 14, 19], "expand": [2, 4, 14, 18], "rule": [2, 3, 14, 15], "translat": [2, 6, 12, 14, 18], "load": [2, 6, 12, 14], "ctor": [2, 14], "aid": [2, 14], "help": [2, 3, 14, 17], "how": [2, 11, 14, 19], "arriv": [2, 11, 14], "post": [2, 4, 10, 12, 13, 14, 15, 16, 18, 19], "autoaddrlist": [2, 14], "member": [2, 6, 9, 10, 12, 13, 14, 16, 17, 18, 19], "addresslist": 2, "ipaddr": 2, "ipmultiaddr": 2, "ttl": [2, 7], "ifaceaddr": 2, "interfac": [2, 3, 7, 10, 13, 14, 15, 16, 17], "constrain": 2, "wildcard": [2, 13, 14, 16, 18], "nameserv": 2, "unsign": [2, 13, 14, 18], "short": [2, 4, 7, 14, 18], "udp_port": [2, 14], "bind": [2, 13, 14], "find": [2, 10, 14, 15, 19], "tcp_port": [2, 14], "extend": [2, 17, 18, 19], "tcptimeout": [2, 14], "interv": [2, 7, 14], "runtime_error": [2, 14, 16, 18, 19], "becaus": 2, "lost": 2, "subclass": [2, 16], "epicstim": [2, 4, 8], "loss": 2, "expir": [2, 3], "ever": 2, "befor": [3, 6, 13, 16, 18, 19], "pleas": 3, "check": [3, 4, 10, 14, 18], "been": [3, 8, 10, 14, 15], "mention": 3, "result": [3, 4, 5, 8, 9, 10, 11, 13, 14, 16, 18], "enough": [3, 10, 18], "vc": [3, 5], "commit": 3, "v": [3, 9, 10, 13, 17, 18, 19], "show": [3, 6, 13, 16, 19], "etc": [3, 18], "compil": [3, 5, 13, 18], "gcc": [3, 5, 13], "concis": [3, 17], "instruct": 3, "reproduc": 3, "relev": [3, 11], "number": [3, 7, 8, 14, 15, 16, 17, 18, 19], "same": [3, 6, 8, 11, 12, 17, 18, 19], "subnet": [3, 10], "traffic": [3, 14], "cross": [3, 5], "machin": 3, "physic": 3, "5074": 3, "successfulli": 3, "much": 3, "kind": [3, 17, 19], "interoper": [3, 13], "privat": 3, "environment": 3, "case": [3, 6, 9, 10, 11, 12, 13, 14, 16, 17, 18, 19], "troublesom": 3, "section": [3, 13], "quick": 3, "guid": [3, 14], "wireshark": 3, "import": [3, 18], "concern": 3, "taken": [3, 8], "unintention": 3, "unrel": 3, "potenti": [3, 13], "sensit": 3, "usag": [3, 4, 13, 14, 15, 18], "lua": 3, "extens": [3, 18], "cashark": 3, "filter": 3, "out": [3, 6, 10, 11, 16], "x": [3, 6, 7, 11, 12, 16, 18, 19], "lua_script": 3, "displai": [3, 6, 8, 9, 10, 13, 17], "menu": 3, "export": [3, 4, 18], "choos": 3, "compress": [3, 10], "gzip": 3, "exchang": [3, 19], "stream": [3, 18], "featur": [3, 6, 13], "associ": [3, 4, 7, 12, 15, 16, 17, 18], "express": [3, 13, 18, 19], "eq": 3, "identifi": [3, 9, 10, 19], "isn": [3, 18], "full": [3, 11, 12, 18], "tshark": 3, "dure": [3, 6, 13, 16, 18], "produc": [3, 13, 18], "cook": 3, "ssh": 3, "w": [3, 4, 13, 15, 19], "pcapng": 3, "gz": 3, "doubt": 3, "about": [3, 6, 9, 10, 16], "exclud": [3, 19], "author": [3, 5], "email": 3, "instead": [3, 10, 12, 13, 19], "upload": 3, "pgp": 3, "below": [3, 12], "semant": 3, "scheme": 3, "major": [3, 8], "minor": [3, 8, 13], "patch": 3, "amend": 3, "backward": [3, 18], "incompat": [3, 8, 13], "part": [3, 6, 8, 10, 12], "everi": [3, 7, 8, 12], "intend": [3, 10, 14, 18], "confid": 3, "upgrad": 3, "increment": [3, 4], "believ": [3, 13], "abi": [3, 18], "made": [3, 6, 10, 11, 12, 19], "sonam": 3, "semi": [3, 13], "At": [3, 6, 19], "both": [3, 6, 9, 10, 12, 13, 16, 18, 19], "main": [3, 4, 10, 18], "libpvx": [3, 5], "auxiliari": 3, "libpvxsioc": 3, "statement": 3, "group": [3, 5, 11, 13, 16, 17], "forward": [3, 5, 6, 13, 18, 19], "construct": [3, 18, 19], "helper": [3, 5, 13, 17], "accompani": 3, "sign": 3, "tag": 3, "repositori": 3, "verifi": 3, "gpg": 3, "5c159e669d69e2d4c4e74e540c8e1c8347330cfb": 3, "subject": [3, 4, 7], "wrap": 3, "ifdef": 3, "pvxs_expert_api_en": 3, "unintent": 3, "best": [3, 10], "effort": 3, "involv": [3, 12, 13], "prospect": 3, "encourag": 3, "contact": 3, "element": [3, 16, 18, 19], "promot": 3, "regular": [3, 13, 18], "warrant": 3, "pull": 3, "indent": [3, 10, 13], "No": [3, 8, 13], "hard": 3, "tab": [3, 18], "unix": 3, "style": [3, 18], "eol": 3, "surround": 3, "meaning": [3, 8, 14, 18], "comment": [3, 18], "reason": [3, 9], "doxygen": 3, "unreleas": [3, 5], "document": [3, 13], "global": [3, 6, 10, 18], "constructor": [3, 18], "destructor": [3, 18], "ok": [3, 5], "tool": [3, 5, 18], "up": [3, 4, 10, 13], "multipl": [3, 11, 12, 14, 15, 18], "whitespac": 3, "who": 3, "did": 3, "graph": 3, "alexand": 3, "basil": 3, "aljam": 3, "bruno": 3, "martin": 3, "\u00e9rico": 3, "nogueira": 3, "georg": 3, "mcintyr": 3, "henriqu": 3, "silva": 3, "karlosp": 3, "klemen": 3, "vodopivec": 3, "michael": 3, "davidsav": 3, "peter": 3, "miln": 3, "simon": 3, "rose": 3, "thoma": [3, 13], "iv": [3, 13], "al": [3, 10, 13], "u": [3, 10], "lbl": 3, "gov": 3, "overview": [3, 5], "project": 3, "berkelei": 3, "lab": 3, "www": 3, "diamond": 3, "light": 3, "sourc": [3, 5, 6, 13, 14, 15, 18], "ac": 3, "uk": 3, "european": 3, "spallat": 3, "europeanspallationsourc": 3, "se": 3, "fermilab": 3, "fnal": 3, "slac": 3, "nation": 3, "acceler": 3, "laboratori": 3, "www6": 3, "stanford": 3, "edu": 3, "sn": 3, "neutron": 3, "ornl": 3, "oak": 3, "ridg": 3, "misc": [3, 5], "design": [3, 10], "share": [3, 13, 15, 19], "fanout": [3, 13], "retri": [3, 11, 16], "linear": 3, "backoff": 3, "step": 3, "bucketinterv": 3, "nbucket": 3, "cpp": [3, 11], "level": [3, 6, 11, 12, 13, 16, 18], "delai": 3, "extra": [3, 8], "bucket": 3, "desir": [3, 12, 19], "too": 3, "larg": [3, 10], "timer": [3, 13], "immedi": [3, 6, 10, 11, 13, 16], "save": [3, 12, 18], "pair": [3, 7, 14], "fielddesc": 3, "fieldstorag": 3, "oper": [3, 4, 5, 7, 10, 11, 12, 13, 15, 16, 17, 18, 19], "around": [3, 10, 19], "hidden": [3, 16], "structtop": 3, "join": 3, "ownership": [3, 5, 13, 14, 19], "buffer": [3, 13, 16], "read": [3, 4, 10, 11, 12, 13, 19], "tcp_readahead": 3, "conn": 3, "byte": [3, 13, 17], "header": [3, 13, 18], "after": [3, 6, 8, 11, 13, 15, 18, 19], "larger": 3, "bodi": 3, "length": [3, 18], "under": 4, "latest": 4, "master": 4, "copyright": 4, "distribut": 4, "softwar": 4, "licens": 4, "agreement": 4, "iostream": 4, "log": [4, 5], "int": [4, 6, 14, 18, 19], "argc": 4, "char": [4, 6, 8, 16, 17, 18], "argv": [4, 15], "pvxs_log": [4, 6, 18], "logger_config_env": [4, 18], "stdout": 4, "sharedpv": [4, 5, 6, 10, 13, 14, 16], "pre": [4, 9, 15, 17, 18, 19], "ntscalar": [4, 5, 8, 11, 12, 13, 15, 17, 19], "primari": [4, 9, 16, 19], "typecod": [4, 8, 9, 10, 15, 17, 19], "float64": [4, 9, 13, 15, 17, 19], "storag": [4, 19], "visibl": [4, 6, 12], "buildmailbox": [4, 15], "open": [4, 7, 10, 13, 15, 16], "epics_pvas_": [4, 7], "addpv": [4, 6, 14], "sigint": [4, 13, 14, 18], "meant": [4, 12], "against": [4, 6, 16], "termin": [4, 18], "And": [4, 13, 19], "lot": 4, "nois": [4, 13], "int32_t": [4, 8, 9, 10, 19], "still": [4, 6, 10, 13], "noconvert": [4, 19], "its": 4, "convert": [4, 13, 19], "els": 4, "won": 4, "happen": [4, 18], "doesn": [4, 13, 16], "put": [4, 5, 10, 11, 12, 13, 15, 16], "toput": 4, "serv": [4, 6, 13, 14, 15], "written": [4, 9, 11], "verbatim": 4, "pvname1": 4, "scalar": [4, 8, 9, 10, 12, 17], "meta": [4, 6, 9, 10, 11, 12], "1u": 4, "0ul": 4, "onput": [4, 15, 16], "whatev": [4, 15], "our": [4, 16, 18, 19], "replac": [4, 10], "rang": [4, 9, 15], "unique_ptr": [4, 15, 16], "execop": [4, 13, 15, 16], "arbitrarili": [4, 12], "clip": [4, 15], "100": 4, "timestamp": [4, 8, 9, 11, 12, 13], "ismark": [4, 10, 15, 19], "epicstimestamp": 4, "epicstimegetcurr": 4, "secondspastepoch": [4, 8, 9], "secpastepoch": 4, "posix_time_at_epics_epoch": [4, 8], "nanosecond": [4, 8, 9], "nsec": 4, "mayb": [4, 10, 14, 19], "move": [4, 12, 15, 16, 18, 19], "forev": 4, "ctrl": [4, 10, 13], "press": 4, "sigterm": [4, 14], "dll": 5, "act": [5, 18, 19], "pvaccess": 5, "pvdatacpp": 5, "hope": [5, 18], "eventu": 5, "supplant": 5, "doc": 5, "contribut": [5, 12], "11": [5, 13], "compliant": 5, "8": [5, 13], "visual": 5, "studio": 5, "2015": 5, "12": 5, "clang": 5, "15": [5, 18], "publish": [5, 10], "polici": [5, 6, 8], "comparison": 5, "iter": [5, 12, 16, 17], "track": [5, 13], "custom": [5, 15, 19], "big": [5, 13], "pictur": 5, "spec": [5, 13], "shortest": 5, "demo": 5, "mailbox": [5, 13, 15], "libevent2": 5, "your": [5, 6, 13], "command": [5, 6, 10], "line": [5, 18], "troubleshoot": [5, 18], "cabl": 5, "tester": 5, "api": [5, 8, 10, 13, 18], "ntscalararrai": [5, 8, 12, 19], "time_t": [5, 9, 12, 19], "alarm_t": [5, 9, 12, 17, 19], "ntndarrai": [5, 19], "nttabl": [5, 13, 19], "rpc": [5, 10, 15, 16], "monitor": [5, 10, 11, 12, 13, 16], "thread": [5, 13, 14, 15, 18, 19], "pvrequest": [5, 13, 16], "syntax": [5, 6, 10, 12, 13, 18], "staticsourc": [5, 14], "lifetim": [5, 14], "integr": 5, "shell": 5, "qsrv": [5, 11, 13], "secur": 5, "identif": 5, "unit": [5, 9, 14], "packet": [5, 7, 13], "expert": [5, 13], "contributor": 5, "implement": [5, 13, 16, 19], "dec": 5, "2023": [5, 12], "oct": 5, "sept": 5, "june": 5, "april": 5, "mar": 5, "feb": 5, "2022": 5, "nov": 5, "jan": [5, 8], "2021": 5, "juli": 5, "apr": 5, "page": 5, "iochook": [6, 18], "exist": [6, 10, 13, 16, 17, 18, 19], "respect": [6, 8, 12], "_registerrecorddevicedriv": 6, "pdbbase": [6, 18], "pvxsr": 6, "pvxsl": 6, "onlist": [6, 16], "pvxsi": 6, "toolchain": 6, "singleton": 6, "setup": [6, 10, 13, 16, 18], "registrar": 6, "inithookaftercaserverrun": 6, "phase": [6, 7], "iocinit": [6, 18], "destroi": [6, 16, 18], "epicsatexit": 6, "hook": 6, "inithookafterinitdatabas": 6, "epicsenvset": 6, "avail": [6, 11, 12, 16, 18], "myinithook": 6, "inithookst": 6, "inithookafteriocbuilt": 6, "mypv": 6, "myregistrar": 6, "inithookregist": 6, "match": [6, 12, 14, 15, 18, 19], "epicsexportregistrar": 6, "logic_error": [6, 13, 19], "replic": 6, "preview": [6, 13], "beta": 6, "opt": 6, "runtim": [6, 18], "pvxs_qsrv_enabl": 6, "NO": [6, 13, 14], "divid": 6, "broad": 6, "categori": 6, "databas": [6, 8, 11], "pvxgl": 6, "pattern": 6, "restrict": [6, 8], "dbloadgroup": [6, 12], "macro": [6, 18], "json": 6, "oppos": 6, "q": [6, 11, 12, 18], "db": [6, 11, 12, 18], "enabl": [6, 18, 19], "aka": [6, 10, 13, 19], "rsrv": 6, "caget": 6, "long": [6, 13, 18], "inp": [6, 11, 12, 18], "suffix": 6, "dbf_string": 6, "dbf_": 6, "interpret": [6, 13], "hint": [6, 9, 11], "opi": 6, "longin": [6, 11], "bit": [6, 10, 13], "0x1234": 6, "hex": [6, 13, 18], "render": [6, 19], "hexadecim": 6, "waveform": 6, "ftvl": [6, 12], "nelm": [6, 12], "1024": 6, "format": [6, 13, 16, 18, 19], "binari": 6, "decim": 6, "exponenti": 6, "engin": 6, "enforc": [6, 13], "acf": [6, 13], "assetfilenam": 6, "just": 6, "rather": 6, "ca": [6, 10, 16], "hostnam": [6, 7, 10], "numer": [6, 9, 10, 12, 16, 19], "ip": [6, 10, 14], "hag": 6, "ascheckclientip": 6, "flag": [6, 13], "trivial": 6, "forg": 6, "usernam": 6, "uag": 6, "item": [6, 19], "role": [6, 16], "system": [6, 10, 17, 18], "authent": [6, 16], "someon": 6, "account": [6, 16], "posix": [6, 8, 13, 18], "tgt": [6, 11], "src": [6, 11, 14, 15], "input": [6, 18], "proce": 7, "resolut": 7, "transfer": [7, 10], "determin": [7, 14, 19], "claim": [7, 14, 16], "similar": [7, 10, 13, 18], "resolv": [7, 13], "reach": 7, "6": [7, 8, 12, 18], "By": [7, 10, 11, 12, 16, 18], "perpetu": 7, "reduc": [7, 13], "gradual": 7, "increas": [7, 11, 12, 13], "overridden": 7, "epics_pvas_beacon_addr_list": [7, 14], "epics_pvas_auto_beacon_addr_list": [7, 14], "tabl": [7, 12], "understood": 7, "explan": 7, "mani": [7, 10, 13, 19], "come": [7, 19], "epics_pvas_intf_addr_list": [7, 14], "epics_pva_server_port": [7, 14], "epics_pvas_server_port": [7, 14], "epics_pvas_broadcast_port": [7, 14], "epics_pvas_ignore_addr_list": [7, 13, 14], "_addr_list": [7, 13, 14], "ip4": 7, "ifacenam": 7, "ip6": 7, "myhost": 7, "startup": 7, "rout": 7, "2600": 7, "1234": 7, "224": 7, "255": 7, "live": 7, "ff02": 7, "br0": 7, "roughli": [7, 18], "factori": 8, "rel": [8, 11, 12], "purpos": 8, "would": [8, 10, 12, 18, 19], "id": [8, 12, 14, 17, 19], "undefin": [8, 12, 18], "consequ": [8, 13], "yet": 8, "explor": 8, "commonli": [8, 10], "int64_t": [8, 9, 19], "usertag": [8, 9], "epoch": 8, "1970": 8, "utc": 8, "631152000": 8, "contextu": 8, "represent": 8, "quantiti": 8, "measur": [8, 10], "reflect": 8, "most": [8, 10, 11, 12, 13, 14, 19], "recent": [8, 11, 12, 13], "ui": [8, 9], "widget": [8, 9], "border": 8, "color": [8, 9], "devic": 8, "driver": [8, 12], "describ": [8, 9, 18, 19], "typedef": [8, 9, 10, 13, 17, 18, 19], "instanti": [8, 9, 17], "imag": 8, "areadetector": 8, "inspir": 8, "dimens": [8, 19], "tabular": [8, 12], "columnar": 8, "unlik": [8, 12, 18], "label": [8, 12], "suitabl": [8, 14], "unmark": [8, 13, 19], "add_column": 8, "column": [8, 12], "primit": [9, 17], "variant": [9, 12, 19], "iscalar": 9, "int64": [9, 10, 17, 19], "pseudo": [9, 19], "ntscalar_int64": 9, "display_t": 9, "limitlow": 9, "limithigh": [9, 10], "descript": [9, 13, 19], "precis": [9, 10, 13], "enum_t": 9, "control_t": 9, "union": [9, 12, 13, 17, 19], "structa": [9, 13, 17, 19], "uniona": [9, 13, 17, 19], "text": [9, 18], "hz": 9, "inclus": 9, "gaug": 9, "unless": [9, 19], "Not": [9, 15], "authorit": 9, "valuealarm": 9, "lowalarmlimit": 9, "highalarmlimit": 9, "lowalarmsever": 9, "highalarmsever": 9, "lowwarninglimit": 9, "highwarninglimit": 9, "lowwarningsever": 9, "highwarningsever": 9, "marker": 9, "warn": [9, 13, 18], "signific": [9, 10], "low": [9, 13, 16], "high": [9, 16], "expect": [9, 13], "myspeci": 9, "org": 10, "ap": 10, "alongsid": 10, "supersed": 10, "four": [10, 12], "world": 10, "idea": 10, "million": 10, "facil": 10, "hardwar": 10, "temperatur": 10, "particular": 10, "sensor": 10, "mylab": 10, "temp1": 10, "electromechan": 10, "relai": 10, "valve2": 10, "perhap": 10, "toggl": 10, "relationship": 10, "uniqu": [10, 12, 14, 18, 19], "url": 10, "hierarch": 10, "domain": 10, "complic": 10, "though": 10, "p4p": 10, "abil": 10, "compon": [10, 18], "packag": [10, 13], "dictat": 10, "interact": 10, "convers": [10, 19], "decid": [10, 15], "correspond": 10, "incorpor": 10, "normativetypescpp": 10, "ntapi": [10, 17, 19], "obviou": 10, "pvdata": 10, "pvfield": 10, "hierarchi": 10, "unsaf": 10, "downcast": 10, "deriv": 10, "further": [10, 14, 15, 16, 18, 19], "smart": 10, "derefer": 10, "contrast": 10, "indirect": 10, "earli": [10, 13], "pvstructureptr": 10, "assum": 10, "pvintptr": 10, "getsubfield": 10, "pvint": 10, "rememb": 10, "experi": 10, "shown": 10, "easi": 10, "forget": 10, "crash": [10, 13], "int32": [10, 17, 19], "pvlong": 10, "improv": [10, 13], "getsubfieldt": 10, "pvscalar": 10, "intermedi": 10, "opportunist": 10, "geta": 10, "behavior": [10, 11, 18], "compact": 10, "wish": 10, "uint32_t": [10, 19], "lim": 10, "1234u": 10, "pvscalarptr": 10, "pvuint": 10, "children": [10, 17, 19], "pvfieldptr": 10, "getpvfield": 10, "getfullnam": 10, "ichildren": [10, 19], "nameof": [10, 19], "iall": [10, 19], "depth": [10, 11, 19], "imark": [10, 19], "bring": 10, "partial": 10, "don": [10, 13, 18], "bitset": 10, "pvstructur": 10, "notifi": [10, 15], "channelgetrequest": 10, "getdon": 10, "st": 10, "channelget": 10, "shared_point": 10, "issuccess": 10, "oop": 10, "getfieldoffset": 10, "unpack": 10, "neither": [10, 19], "nor": 10, "obtain": [10, 19], "offset": 10, "queri": [10, 15], "wrong": [10, 18], "knowledg": 10, "concept": 10, "ifmark": [10, 19], "occur": [10, 12], "complement": 10, "et": [10, 13], "bitsetptr": 10, "getnumberfield": 10, "putfrom": 10, "assert": [10, 13, 18, 19], "norm": 10, "createbuild": 10, "addalarm": 10, "addtimestamp": 10, "adddisplai": 10, "createpvstructur": 10, "fieldbuild": 10, "pvd": 10, "getfieldcr": 10, "createfieldbuild": 10, "addnestedstructur": 10, "endnest": 10, "createstructur": 10, "One": [10, 12], "correctli": [10, 13, 19], "beautifi": 10, "heavili": 10, "influenc": 10, "pvac": 10, "clientprovid": 10, "principl": 10, "clientchannel": 10, "getcallback": 10, "mygetcallback": 10, "inprog": 10, "getev": 10, "overrid": [10, 18], "startop": 10, "chan": 10, "schema": [11, 12], "proc": [11, 12], "none": 11, "sevr": 11, "monord": 11, "defer": [11, 13], "atom": [11, 12, 18], "variou": [11, 13, 16, 19], "flow": [11, 16], "npp": 11, "pp": 11, "cp": 11, "scan": 11, "behav": [11, 19], "maxim": 11, "nm": 11, "msi": 11, "mss": 11, "almost": [11, 12, 17, 18], "tse": 11, "incomplet": [11, 13], "tri": 11, "lock": [11, 13, 15, 18], "dblockmani": 11, "accumul": [11, 18], "longout": [11, 12], "trigger": [11, 12, 13, 18], "flush": 11, "discret": [11, 12], "opposit": 11, "map": [12, 13], "split": 12, "among": 12, "ai": 12, "rec": 12, "grp": 12, "y": [12, 16], "enclos": [12, 19], "Or": 12, "udf": 12, "benefit": 12, "former": 12, "group_nam": 12, "putord": [12, 13], "plain": 12, "alia": [12, 14, 19], "constitu": 12, "caus": [12, 13], "comma": 12, "chain": 12, "itself": [12, 14, 19], "confus": 12, "give": [12, 16], "behaviour": 12, "writabl": 12, "motiv": 12, "encod": [12, 13], "overal": 12, "goal": 12, "tst": 12, "tbl": 12, "seri": 12, "caput": 12, "08": 12, "09": 12, "55": 12, "19": 12, "999": 12, "achiev": 12, "onto": 12, "aao": 12, "third": 12, "action": [12, 16, 18], "illustr": 12, "left": [12, 14], "hand": 12, "content": 12, "right": 12, "here": 12, "labels_": 12, "might": 12, "necessarili": 12, "manner": 12, "_save": 12, "dbloadrecord": 12, "lbl1": 12, "lbl2": 12, "po1": 12, "po2": 12, "aai": 12, "tpro": 12, "mdel": 12, "ensur": [12, 13, 19], "we": [12, 15, 16, 18], "fd": 13, "tcp_nodelai": 13, "winsock": 13, "workaround": 13, "astrapwrit": 13, "clobber": 13, "dbchannel": 13, "fix": [13, 18], "permit": 13, "correct": 13, "python": 13, "disambigu": 13, "selector": 13, "decod": 13, "relax": 13, "propag": 13, "bound": [13, 16, 18], "promptli": 13, "db_cancel_ev": 13, "monitorcontrolop": [13, 16], "423": 13, "typo": 13, "dbr_string": 13, "dbprocess": 13, "dbf_enum": 13, "_option": 13, "pvxs_enable_ipv6": 13, "disabl": 13, "mi": 13, "omiss": 13, "connectop": [13, 16], "longer": 13, "target_inform": [13, 18], "clarifi": 13, "testprepar": 13, "analysi": 13, "quiet": 13, "erron": 13, "exce": 13, "py": 13, "alex": 13, "localhost": 13, "schedul": 13, "poke": 13, "self": [13, 14], "copyin": 13, "monitorstat": [13, 16], "nsquash": [13, 16], "delta": [13, 19], "sync": 13, "compound": [13, 17, 19], "regress": 13, "wrapper": 13, "manipul": [13, 15, 16], "diff": [13, 18], "teststreq": [13, 18], "msvc": [13, 18], "wd": 13, "sometim": 13, "nmember": [13, 19], "parent": [13, 19], "corrupt": 13, "magic": [13, 16], "shared_arrai": [13, 19], "convertto": [13, 19], "float32": [13, 17, 19], "rework": 13, "cleanup": [13, 16], "disarm": 13, "thaw": [13, 19], "nofield": [13, 19], "setuptools_dso": 13, "7a1": 13, "typestor": 13, "unchang": 13, "kept": 13, "safeti": 13, "watermark": 13, "edg": 13, "overload": 13, "clear": [13, 19], "17": 13, "ioid": 13, "cmd_messag": 13, "calcul": 13, "term": 13, "water": 13, "1400": 13, "off": 13, "reconnect": 13, "miss": 13, "quot": [13, 18], "ifaddr": 13, "ifa_addr": 13, "endian": 13, "loopback": [13, 14], "cmd_origin_tag": 13, "hack": 13, "pvxlist": 13, "mode": 13, "go": 13, "down": 13, "casw": 13, "gentler": 13, "skip": 13, "discoveri": 13, "pvxsmonitor": 13, "hang": 13, "race": 13, "dump": 13, "64": 13, "teststrmatch": [13, 18], "previous": [13, 14, 18], "nonsens": 13, "ambigu": [13, 19], "simplifi": 13, "complex": [13, 16], "prune": 13, "unus": [13, 14], "ignoreaddr": [13, 14], "creation": [13, 15], "retent": 13, "preliminari": 13, "rtem": 13, "libbsd": 13, "logger_level_set": [13, 18], "logger": [13, 18], "err": [13, 18], "fall": [13, 18], "back": [13, 18], "iosfwd": 13, "ostream": [13, 16, 18, 19], "so_rxq_ovfl": 13, "stall": 13, "incorrect": 13, "rais": 13, "fragment": 13, "pvaccessjava": 13, "incorrectli": 13, "direct": 13, "pvxs_abi_vers": [13, 18], "testthrowsmatch": [13, 18], "unitttest": 13, "builtin": 13, "__builtin": [13, 14], "__server": [13, 14], "__": [13, 14], "reserv": [13, 14, 18], "recip": 14, "addsourc": [14, 15], "intil": 14, "preced": [14, 19], "establish": 14, "lowest": 14, "win": 14, "suppliment": 14, "beacondestin": 14, "auto_beacon": 14, "chosen": 14, "origin": [14, 19], "supplement": 14, "serverguid": 14, "readback": 14, "famili": 14, "af_inet": 14, "randomli": 14, "announc": 14, "even": [14, 15], "pvlist": 14, "program": 14, "moment": [14, 18], "clientconfig": 14, "removepv": 14, "removesourc": 14, "oncreat": [14, 15, 16], "disassoci": 14, "getsourc": 14, "listsourc": 14, "sens": 15, "box": 15, "simpli": 15, "opput": 15, "max": 15, "min": 15, "discard": 15, "onrpc": [15, 16], "channelcontrol": [15, 16], "onfirstconnect": 15, "onlastdisconnect": 15, "isopen": 15, "revers": 15, "remain": [15, 19], "dispatch": 15, "shallow": 15, "buildreadonli": 15, "reject": [15, 16], "behalf": 16, "predetermin": 16, "respond": 16, "gatewai": 16, "proxi": 16, "bridg": 16, "underli": [16, 18, 19], "oncancel": 16, "ti": 16, "onget": 16, "closur": 16, "onsearch": 16, "calle": 16, "noth": 16, "higher": 16, "chanc": 16, "sethandl": 16, "strm": 16, "dynam": 16, "sought": 16, "strcmp": 16, "endpoint": 16, "abl": 16, "opbas": 16, "monitorsetupop": 16, "peernam": 16, "clientcredenti": 16, "credenti": 16, "op_t": 16, "msg": 16, "peer": [16, 19], "onclos": 16, "forcepost": 16, "nfree": 16, "over": 16, "0u": [16, 18, 19], "squash": 16, "trypost": 16, "setwatermark": 16, "outbound": 16, "ack": 16, "onlowmark": 16, "onhighmark": 16, "abov": 16, "onstart": 16, "acquir": 16, "onop": 16, "onsubscrib": 16, "outsid": 16, "nqueue": 16, "un": 16, "serial": 16, "tx": 16, "maxqueu": 16, "highest": 16, "limitqueu": 16, "negoti": 16, "primarili": 16, "anonym": 16, "nix": 16, "secondari": 16, "ifac": 16, "upon": [16, 19], "consist": 17, "code_t": 17, "exhaust": 17, "ifield": 17, "fval": 17, "substruct": 17, "desc": 17, "uint32": [17, 19], "stringa": 17, "boola": 17, "int8": [17, 19], "int16": [17, 19], "uint8": [17, 19], "uint16": [17, 19], "uint64": [17, 19], "int8a": 17, "int16a": 17, "int32a": 17, "int64a": 17, "uint8a": 17, "uint16a": 17, "uint32a": 17, "uint64a": 17, "float32a": 17, "float64a": [17, 19], "anya": 17, "uint8_t": [17, 19], "isunsign": 17, "isarrai": 17, "arrayof": 17, "scalarof": 17, "scratch": 17, "def1": 17, "def2": 17, "initializer_list": [17, 19], "notat": 17, "errlog": 18, "prefix": [18, 19], "less": 18, "equal": [18, 19], "crit": 18, "liter": 18, "lvl": 18, "logger_level_clear": 18, "emit": 18, "define_logg": 18, "usabl": 18, "var": 18, "log_printf": 18, "friend": 18, "log_crit_printf": 18, "fmt": [18, 19], "log_err_printf": 18, "log_warn_printf": 18, "log_info_printf": 18, "log_debug_printf": 18, "due": 18, "portabl": 18, "least": 18, "blahfn": 18, "pvxs_version": 18, "version_int": 18, "constant": 18, "condition": 18, "endif": 18, "version_str": 18, "version_abi_int": 18, "version_abi_check": 18, "newer": 18, "epicsunittest": 18, "testtru": 18, "evalu": [18, 19], "testcas": 18, "testfals": 18, "testeq": 18, "lh": 18, "rh": 18, "testok": 18, "testnoteq": 18, "friendlier": 18, "multi": 18, "str": 18, "testarreq": 18, "testshow": 18, "diagnost": 18, "testdiag": 18, "realli": 18, "shouldn": 18, "testthrow": 18, "me": 18, "callabl": 18, "caught": 18, "diag": 18, "setpass": 18, "setpassmatch": 18, "testioc": 18, "manag": 18, "life": 18, "cycl": 18, "dbunittest": 18, "mytest": 18, "testplan": 18, "todo": 18, "testsetup": 18, "testdbprepar": 18, "mytestioc": 18, "testdbreaddatabas": 18, "mytestioc_registerrecorddevicedriv": 18, "sometest": 18, "init": 18, "shutdown": 18, "epicsexitcallatexit": 18, "cleanup_for_valgrind": 18, "escap": 18, "printabl": 18, "charact": 18, "newlin": 18, "xab": 18, "xabcas": 18, "nil": 18, "free": [18, 19], "valgrind": 18, "memori": 18, "libevent_global_shutdown": 18, "afterward": 18, "restor": [18, 19], "dtor": 18, "ran": 18, "iocsh": 18, "pvxs_target_inform": 18, "consum": [18, 19], "value_typ": 18, "movabl": 18, "entrant": 18, "destruct": 18, "emplac": 18, "greater": 18, "Will": 18, "ent": 18, "typedefapi": 19, "node": 19, "leaf": 19, "fldname": 19, "anon": 19, "static_cast": 19, "chief": 19, "cast": 19, "nonexist": 19, "variat": 19, "travers": 19, "child": 19, "grandchildren": 19, "visit": 19, "beem": 19, "ident": 19, "temporari": 19, "stand": 19, "allocmemb": 19, "newli": 19, "ref": 19, "referenc": 19, "storetyp": 19, "storagetyp": 19, "idstartswith": 19, "equalinst": 19, "equaltyp": 19, "descend": 19, "uint16_t": 19, "uint64_t": 19, "int8_t": 19, "int16_t": 19, "float": 19, "coerc": 19, "impl": 19, "storagemap": 19, "typenamestd": 19, "decai": 19, "not_stor": 19, "tryfrom": 19, "k": 19, "booleanvalu": 19, "hopefulli": 19, "lookuperror": 19, "satisfi": 19, "noexcept": 19, "arraylimit": 19, "_iall": 19, "_ichildren": 19, "_imark": 19, "format_t": 19, "showvalu": 19, "cnt": 19, "truncat": 19, "transform": 19, "freez": 19, "arr": 19, "exclus": 19, "frozen": 19, "original_typ": 19, "arraytyp": 19, "castto": 19, "untyp": 19, "varr": 19, "temp": 19, "sa_bas": 19, "contigu": 19, "constarr": 19, "preserv": 19, "voidarr": 19, "l": 19, "iterator_trait": 19, "difference_typ": 19, "sequenc": 19, "len": 19, "delet": 19, "deletor": 19, "swap": 19, "resiz": 19, "make_uniqu": 19, "sa": 19, "out_of_rang": 19, "add_const": 19, "remove_const": 19, "TO": 19, "ness": 19, "entir": 19, "elements": 19, "sizeof": 19, "maximum": 19}, "objects": {"": [[18, 0, 1, "c.DEFINE_LOGGER", "DEFINE_LOGGER"], [18, 0, 1, "c.PVXS_ABI_VERSION", "PVXS_ABI_VERSION"], [18, 0, 1, "c.PVXS_VERSION", "PVXS_VERSION"], [18, 0, 1, "c.VERSION_INT", "VERSION_INT"], [18, 0, 1, "c.log_crit_printf", "log_crit_printf"], [18, 0, 1, "c.log_debug_printf", "log_debug_printf"], [18, 0, 1, "c.log_err_printf", "log_err_printf"], [18, 0, 1, "c.log_info_printf", "log_info_printf"], [18, 0, 1, "c.log_printf", "log_printf"], [18, 0, 1, "c.log_warn_printf", "log_warn_printf"], [18, 0, 1, "c.testArrEq", "testArrEq"], [18, 0, 1, "c.testEq", "testEq"], [18, 0, 1, "c.testFalse", "testFalse"], [18, 0, 1, "c.testNotEq", "testNotEq"], [18, 0, 1, "c.testShow", "testShow"], [18, 0, 1, "c.testStrEq", "testStrEq"], [18, 0, 1, "c.testStrMatch", "testStrMatch"], [18, 0, 1, "c.testTrue", "testTrue"], [6, 1, 1, "_CPPv411dbLoadGroupPKcPKc", "dbLoadGroup"], [6, 2, 1, "_CPPv411dbLoadGroupPKcPKc", "dbLoadGroup::file"], [6, 2, 1, "_CPPv411dbLoadGroupPKcPKc", "dbLoadGroup::macros"], [6, 1, 1, "_CPPv45pvxgliPKc", "pvxgl"], [6, 2, 1, "_CPPv45pvxgliPKc", "pvxgl::level"], [6, 2, 1, "_CPPv45pvxgliPKc", "pvxgl::pattern"], [19, 3, 1, "_CPPv4N4pvxs9ArrayTypeE", "pvxs::ArrayType"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType4BoolE", "pvxs::ArrayType::Bool"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType7Float32E", "pvxs::ArrayType::Float32"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType7Float64E", "pvxs::ArrayType::Float64"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType5Int16E", "pvxs::ArrayType::Int16"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType5Int32E", "pvxs::ArrayType::Int32"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType5Int64E", "pvxs::ArrayType::Int64"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType4Int8E", "pvxs::ArrayType::Int8"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType4NullE", "pvxs::ArrayType::Null"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType6StringE", "pvxs::ArrayType::String"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType6UInt16E", "pvxs::ArrayType::UInt16"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType6UInt32E", "pvxs::ArrayType::UInt32"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType6UInt64E", "pvxs::ArrayType::UInt64"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType5UInt8E", "pvxs::ArrayType::UInt8"], [19, 4, 1, "_CPPv4N4pvxs9ArrayType5ValueE", "pvxs::ArrayType::Value"], [17, 3, 1, "_CPPv4N4pvxs4KindE", "pvxs::Kind"], [17, 4, 1, "_CPPv4N4pvxs4Kind4BoolE", "pvxs::Kind::Bool"], [17, 4, 1, "_CPPv4N4pvxs4Kind8CompoundE", "pvxs::Kind::Compound"], [17, 4, 1, "_CPPv4N4pvxs4Kind7IntegerE", "pvxs::Kind::Integer"], [17, 4, 1, "_CPPv4N4pvxs4Kind4NullE", "pvxs::Kind::Null"], [17, 4, 1, "_CPPv4N4pvxs4Kind4RealE", "pvxs::Kind::Real"], [17, 4, 1, "_CPPv4N4pvxs4Kind6StringE", "pvxs::Kind::String"], [18, 3, 1, "_CPPv4N4pvxs5LevelE", "pvxs::Level"], [18, 4, 1, "_CPPv4N4pvxs5Level4CritE", "pvxs::Level::Crit"], [18, 4, 1, "_CPPv4N4pvxs5Level5DebugE", "pvxs::Level::Debug"], [18, 4, 1, "_CPPv4N4pvxs5Level3ErrE", "pvxs::Level::Err"], [18, 4, 1, "_CPPv4N4pvxs5Level4InfoE", "pvxs::Level::Info"], [18, 4, 1, "_CPPv4N4pvxs5Level4WarnE", "pvxs::Level::Warn"], [19, 5, 1, "_CPPv4N4pvxs11LookupErrorE", "pvxs::LookupError"], [18, 5, 1, "_CPPv4I0EN4pvxs8MPMCFIFOE", "pvxs::MPMCFIFO"], [18, 1, 1, "_CPPv4N4pvxs8MPMCFIFO8MPMCFIFOE6size_t", "pvxs::MPMCFIFO::MPMCFIFO"], [18, 2, 1, "_CPPv4N4pvxs8MPMCFIFO8MPMCFIFOE6size_t", "pvxs::MPMCFIFO::MPMCFIFO::limit"], [18, 6, 1, "_CPPv4I0EN4pvxs8MPMCFIFOE", "pvxs::MPMCFIFO::T"], [18, 1, 1, "_CPPv4IDpEN4pvxs8MPMCFIFO7emplaceEvDpRR4Args", "pvxs::MPMCFIFO::emplace"], [18, 6, 1, "_CPPv4IDpEN4pvxs8MPMCFIFO7emplaceEvDpRR4Args", "pvxs::MPMCFIFO::emplace::Args"], [18, 2, 1, "_CPPv4IDpEN4pvxs8MPMCFIFO7emplaceEvDpRR4Args", "pvxs::MPMCFIFO::emplace::args"], [18, 1, 1, "_CPPv4N4pvxs8MPMCFIFO3popEv", "pvxs::MPMCFIFO::pop"], [18, 1, 1, "_CPPv4N4pvxs8MPMCFIFO4pushERK1T", "pvxs::MPMCFIFO::push"], [18, 1, 1, "_CPPv4N4pvxs8MPMCFIFO4pushERR1T", "pvxs::MPMCFIFO::push"], [18, 2, 1, "_CPPv4N4pvxs8MPMCFIFO4pushERK1T", "pvxs::MPMCFIFO::push::ent"], [18, 2, 1, "_CPPv4N4pvxs8MPMCFIFO4pushERR1T", "pvxs::MPMCFIFO::push::ent"], [18, 1, 1, "_CPPv4NK4pvxs8MPMCFIFO4sizeEv", "pvxs::MPMCFIFO::size"], [18, 7, 1, "_CPPv4N4pvxs8MPMCFIFO10value_typeE", "pvxs::MPMCFIFO::value_type"], [18, 1, 1, "_CPPv4N4pvxs8MPMCFIFOD0Ev", "pvxs::MPMCFIFO::~MPMCFIFO"], [17, 5, 1, "_CPPv4N4pvxs6MemberE", "pvxs::Member"], [17, 1, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringE", "pvxs::Member::Member"], [17, 1, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member"], [17, 1, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringERKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member"], [17, 1, 1, "_CPPv4N4pvxs6Member6MemberEv", "pvxs::Member::Member"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::children"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringERKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::children"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringE", "pvxs::Member::Member::code"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::code"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringERKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::code"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringERKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::id"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringE", "pvxs::Member::Member::name"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::name"], [17, 2, 1, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringERKNSt6stringENSt16initializer_listI6MemberEE", "pvxs::Member::Member::name"], [19, 5, 1, "_CPPv4N4pvxs9NoConvertE", "pvxs::NoConvert"], [19, 5, 1, "_CPPv4N4pvxs7NoFieldE", "pvxs::NoField"], [18, 5, 1, "_CPPv4N4pvxs6SigIntE", "pvxs::SigInt"], [17, 5, 1, "_CPPv4N4pvxs8TypeCodeE", "pvxs::TypeCode"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t3AnyE", "pvxs::TypeCode::Any"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4AnyAE", "pvxs::TypeCode::AnyA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4BoolE", "pvxs::TypeCode::Bool"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5BoolAE", "pvxs::TypeCode::BoolA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7Float32E", "pvxs::TypeCode::Float32"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t8Float32AE", "pvxs::TypeCode::Float32A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7Float64E", "pvxs::TypeCode::Float64"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t8Float64AE", "pvxs::TypeCode::Float64A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int16E", "pvxs::TypeCode::Int16"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6Int16AE", "pvxs::TypeCode::Int16A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int32E", "pvxs::TypeCode::Int32"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6Int32AE", "pvxs::TypeCode::Int32A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int64E", "pvxs::TypeCode::Int64"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6Int64AE", "pvxs::TypeCode::Int64A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4Int8E", "pvxs::TypeCode::Int8"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int8AE", "pvxs::TypeCode::Int8A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4NullE", "pvxs::TypeCode::Null"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6StringE", "pvxs::TypeCode::String"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7StringAE", "pvxs::TypeCode::StringA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6StructE", "pvxs::TypeCode::Struct"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7StructAE", "pvxs::TypeCode::StructA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt16E", "pvxs::TypeCode::UInt16"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7UInt16AE", "pvxs::TypeCode::UInt16A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt32E", "pvxs::TypeCode::UInt32"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7UInt32AE", "pvxs::TypeCode::UInt32A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt64E", "pvxs::TypeCode::UInt64"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7UInt64AE", "pvxs::TypeCode::UInt64A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5UInt8E", "pvxs::TypeCode::UInt8"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt8AE", "pvxs::TypeCode::UInt8A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5UnionE", "pvxs::TypeCode::Union"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UnionAE", "pvxs::TypeCode::UnionA"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode7arrayOfEv", "pvxs::TypeCode::arrayOf"], [17, 8, 1, "_CPPv4N4pvxs8TypeCode4codeE", "pvxs::TypeCode::code"], [17, 3, 1, "_CPPv4N4pvxs8TypeCode6code_tE", "pvxs::TypeCode::code_t"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t3AnyE", "pvxs::TypeCode::code_t::Any"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4AnyAE", "pvxs::TypeCode::code_t::AnyA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4BoolE", "pvxs::TypeCode::code_t::Bool"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5BoolAE", "pvxs::TypeCode::code_t::BoolA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7Float32E", "pvxs::TypeCode::code_t::Float32"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t8Float32AE", "pvxs::TypeCode::code_t::Float32A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7Float64E", "pvxs::TypeCode::code_t::Float64"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t8Float64AE", "pvxs::TypeCode::code_t::Float64A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int16E", "pvxs::TypeCode::code_t::Int16"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6Int16AE", "pvxs::TypeCode::code_t::Int16A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int32E", "pvxs::TypeCode::code_t::Int32"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6Int32AE", "pvxs::TypeCode::code_t::Int32A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int64E", "pvxs::TypeCode::code_t::Int64"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6Int64AE", "pvxs::TypeCode::code_t::Int64A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4Int8E", "pvxs::TypeCode::code_t::Int8"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5Int8AE", "pvxs::TypeCode::code_t::Int8A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t4NullE", "pvxs::TypeCode::code_t::Null"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6StringE", "pvxs::TypeCode::code_t::String"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7StringAE", "pvxs::TypeCode::code_t::StringA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6StructE", "pvxs::TypeCode::code_t::Struct"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7StructAE", "pvxs::TypeCode::code_t::StructA"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt16E", "pvxs::TypeCode::code_t::UInt16"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7UInt16AE", "pvxs::TypeCode::code_t::UInt16A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt32E", "pvxs::TypeCode::code_t::UInt32"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7UInt32AE", "pvxs::TypeCode::code_t::UInt32A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt64E", "pvxs::TypeCode::code_t::UInt64"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t7UInt64AE", "pvxs::TypeCode::code_t::UInt64A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5UInt8E", "pvxs::TypeCode::code_t::UInt8"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UInt8AE", "pvxs::TypeCode::code_t::UInt8A"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t5UnionE", "pvxs::TypeCode::code_t::Union"], [17, 4, 1, "_CPPv4N4pvxs8TypeCode6code_t6UnionAE", "pvxs::TypeCode::code_t::UnionA"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode7isarrayEv", "pvxs::TypeCode::isarray"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode10isunsignedEv", "pvxs::TypeCode::isunsigned"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode4nameEv", "pvxs::TypeCode::name"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode5orderEv", "pvxs::TypeCode::order"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode8scalarOfEv", "pvxs::TypeCode::scalarOf"], [17, 1, 1, "_CPPv4NK4pvxs8TypeCode4sizeEv", "pvxs::TypeCode::size"], [17, 5, 1, "_CPPv4N4pvxs7TypeDefE", "pvxs::TypeDef"], [17, 1, 1, "_CPPv4I0EN4pvxs7TypeDef7TypeDefE8TypeCodeRKNSt6stringERK8Iterable", "pvxs::TypeDef::TypeDef"], [17, 1, 1, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCode", "pvxs::TypeDef::TypeDef"], [17, 1, 1, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCodeNSt16initializer_listI6MemberEE", "pvxs::TypeDef::TypeDef"], [17, 1, 1, "_CPPv4N4pvxs7TypeDef7TypeDefERK5Value", "pvxs::TypeDef::TypeDef"], [17, 1, 1, "_CPPv4N4pvxs7TypeDef7TypeDefEv", "pvxs::TypeDef::TypeDef"], [17, 6, 1, "_CPPv4I0EN4pvxs7TypeDef7TypeDefE8TypeCodeRKNSt6stringERK8Iterable", "pvxs::TypeDef::TypeDef::Iterable"], [17, 2, 1, "_CPPv4I0EN4pvxs7TypeDef7TypeDefE8TypeCodeRKNSt6stringERK8Iterable", "pvxs::TypeDef::TypeDef::children"], [17, 2, 1, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCodeNSt16initializer_listI6MemberEE", "pvxs::TypeDef::TypeDef::children"], [17, 2, 1, "_CPPv4I0EN4pvxs7TypeDef7TypeDefE8TypeCodeRKNSt6stringERK8Iterable", "pvxs::TypeDef::TypeDef::code"], [17, 2, 1, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCode", "pvxs::TypeDef::TypeDef::code"], [17, 2, 1, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCodeNSt16initializer_listI6MemberEE", "pvxs::TypeDef::TypeDef::code"], [17, 2, 1, "_CPPv4I0EN4pvxs7TypeDef7TypeDefE8TypeCodeRKNSt6stringERK8Iterable", "pvxs::TypeDef::TypeDef::id"], [17, 1, 1, "_CPPv4NK4pvxs7TypeDef2asE8TypeCodeRKNSt6stringE", "pvxs::TypeDef::as"], [17, 1, 1, "_CPPv4NK4pvxs7TypeDef2asERKNSt6stringE", "pvxs::TypeDef::as"], [17, 2, 1, "_CPPv4NK4pvxs7TypeDef2asE8TypeCodeRKNSt6stringE", "pvxs::TypeDef::as::code"], [17, 2, 1, "_CPPv4NK4pvxs7TypeDef2asE8TypeCodeRKNSt6stringE", "pvxs::TypeDef::as::name"], [17, 2, 1, "_CPPv4NK4pvxs7TypeDef2asERKNSt6stringE", "pvxs::TypeDef::as::name"], [17, 1, 1, "_CPPv4NK4pvxs7TypeDef6createEv", "pvxs::TypeDef::create"], [17, 1, 1, "_CPPv4I0EN4pvxs7TypeDefpLER7TypeDefRK8Iterable", "pvxs::TypeDef::operator+="], [17, 6, 1, "_CPPv4I0EN4pvxs7TypeDefpLER7TypeDefRK8Iterable", "pvxs::TypeDef::operator+=::Iterable"], [17, 2, 1, "_CPPv4I0EN4pvxs7TypeDefpLER7TypeDefRK8Iterable", "pvxs::TypeDef::operator+=::children"], [19, 5, 1, "_CPPv4N4pvxs5ValueE", "pvxs::Value"], [19, 5, 1, "_CPPv4N4pvxs5Value3FmtE", "pvxs::Value::Fmt"], [19, 1, 1, "_CPPv4N4pvxs5Value3Fmt10arrayLimitE6size_t", "pvxs::Value::Fmt::arrayLimit"], [19, 2, 1, "_CPPv4N4pvxs5Value3Fmt10arrayLimitE6size_t", "pvxs::Value::Fmt::arrayLimit::cnt"], [19, 1, 1, "_CPPv4N4pvxs5Value3Fmt5deltaEv", "pvxs::Value::Fmt::delta"], [19, 1, 1, "_CPPv4N4pvxs5Value3Fmt6formatE8format_t", "pvxs::Value::Fmt::format"], [19, 2, 1, "_CPPv4N4pvxs5Value3Fmt6formatE8format_t", "pvxs::Value::Fmt::format::f"], [19, 1, 1, "_CPPv4N4pvxs5Value3Fmt9showValueEb", "pvxs::Value::Fmt::showValue"], [19, 2, 1, "_CPPv4N4pvxs5Value3Fmt9showValueEb", "pvxs::Value::Fmt::showValue::v"], [19, 1, 1, "_CPPv4N4pvxs5Value3Fmt4treeEv", "pvxs::Value::Fmt::tree"], [19, 5, 1, "_CPPv4I0EN4pvxs5Value8IterableE", "pvxs::Value::Iterable"], [19, 6, 1, "_CPPv4I0EN4pvxs5Value8IterableE", "pvxs::Value::Iterable::T"], [19, 1, 1, "_CPPv4N4pvxs5Value5ValueEv", "pvxs::Value::Value"], [19, 5, 1, "_CPPv4N4pvxs5Value5_IAllE", "pvxs::Value::_IAll"], [19, 5, 1, "_CPPv4N4pvxs5Value10_IChildrenE", "pvxs::Value::_IChildren"], [19, 5, 1, "_CPPv4N4pvxs5Value8_IMarkedE", "pvxs::Value::_IMarked"], [19, 1, 1, "_CPPv4N4pvxs5Value11allocMemberEv", "pvxs::Value::allocMember"], [19, 1, 1, "_CPPv4I00ENK4pvxs5Value2asEN4impl10StorageMapIN11typenamestd5decayI2FNE4typeEE12not_storableERR2FN", "pvxs::Value::as"], [19, 1, 1, "_CPPv4I0ENK4pvxs5Value2asE1Tv", "pvxs::Value::as"], [19, 1, 1, "_CPPv4I0ENK4pvxs5Value2asEbR1T", "pvxs::Value::as"], [19, 6, 1, "_CPPv4I00ENK4pvxs5Value2asEN4impl10StorageMapIN11typenamestd5decayI2FNE4typeEE12not_storableERR2FN", "pvxs::Value::as::FN"], [19, 6, 1, "_CPPv4I00ENK4pvxs5Value2asEN4impl10StorageMapIN11typenamestd5decayI2FNE4typeEE12not_storableERR2FN", "pvxs::Value::as::T"], [19, 6, 1, "_CPPv4I0ENK4pvxs5Value2asE1Tv", "pvxs::Value::as::T"], [19, 6, 1, "_CPPv4I0ENK4pvxs5Value2asEbR1T", "pvxs::Value::as::T"], [19, 2, 1, "_CPPv4I00ENK4pvxs5Value2asEN4impl10StorageMapIN11typenamestd5decayI2FNE4typeEE12not_storableERR2FN", "pvxs::Value::as::fn"], [19, 2, 1, "_CPPv4I0ENK4pvxs5Value2asEbR1T", "pvxs::Value::as::val"], [19, 1, 1, "_CPPv4N4pvxs5Value6assignERK5Value", "pvxs::Value::assign"], [19, 2, 1, "_CPPv4N4pvxs5Value6assignERK5Value", "pvxs::Value::assign::o"], [19, 1, 1, "_CPPv4N4pvxs5Value5clearEv", "pvxs::Value::clear"], [19, 1, 1, "_CPPv4NK4pvxs5Value5cloneEv", "pvxs::Value::clone"], [19, 1, 1, "_CPPv4NK4pvxs5Value10cloneEmptyEv", "pvxs::Value::cloneEmpty"], [19, 1, 1, "_CPPv4NK4pvxs5Value9equalInstERK5Value", "pvxs::Value::equalInst"], [19, 2, 1, "_CPPv4NK4pvxs5Value9equalInstERK5Value", "pvxs::Value::equalInst::o"], [19, 1, 1, "_CPPv4NK4pvxs5Value9equalTypeERK5Value", "pvxs::Value::equalType"], [19, 2, 1, "_CPPv4NK4pvxs5Value9equalTypeERK5Value", "pvxs::Value::equalType::o"], [19, 1, 1, "_CPPv4NK4pvxs5Value6formatEv", "pvxs::Value::format"], [19, 1, 1, "_CPPv4I0EN4pvxs5Value4fromEvRK1T", "pvxs::Value::from"], [19, 6, 1, "_CPPv4I0EN4pvxs5Value4fromEvRK1T", "pvxs::Value::from::T"], [19, 2, 1, "_CPPv4I0EN4pvxs5Value4fromEvRK1T", "pvxs::Value::from::val"], [19, 1, 1, "_CPPv4NK4pvxs5Value4iallEv", "pvxs::Value::iall"], [19, 1, 1, "_CPPv4NK4pvxs5Value9ichildrenEv", "pvxs::Value::ichildren"], [19, 1, 1, "_CPPv4NK4pvxs5Value2idEv", "pvxs::Value::id"], [19, 1, 1, "_CPPv4NK4pvxs5Value12idStartsWithERKNSt6stringE", "pvxs::Value::idStartsWith"], [19, 2, 1, "_CPPv4NK4pvxs5Value12idStartsWithERKNSt6stringE", "pvxs::Value::idStartsWith::prefix"], [19, 1, 1, "_CPPv4NK4pvxs5Value8ifMarkedEbb", "pvxs::Value::ifMarked"], [19, 2, 1, "_CPPv4NK4pvxs5Value8ifMarkedEbb", "pvxs::Value::ifMarked::children"], [19, 2, 1, "_CPPv4NK4pvxs5Value8ifMarkedEbb", "pvxs::Value::ifMarked::parents"], [19, 1, 1, "_CPPv4NK4pvxs5Value7imarkedEv", "pvxs::Value::imarked"], [19, 1, 1, "_CPPv4NK4pvxs5Value8isMarkedEbb", "pvxs::Value::isMarked"], [19, 2, 1, "_CPPv4NK4pvxs5Value8isMarkedEbb", "pvxs::Value::isMarked::children"], [19, 2, 1, "_CPPv4NK4pvxs5Value8isMarkedEbb", "pvxs::Value::isMarked::parents"], [19, 1, 1, "_CPPv4N4pvxs5Value6lookupERKNSt6stringE", "pvxs::Value::lookup"], [19, 2, 1, "_CPPv4N4pvxs5Value6lookupERKNSt6stringE", "pvxs::Value::lookup::name"], [19, 1, 1, "_CPPv4N4pvxs5Value4markEb", "pvxs::Value::mark"], [19, 2, 1, "_CPPv4N4pvxs5Value4markEb", "pvxs::Value::mark::v"], [19, 1, 1, "_CPPv4NK4pvxs5Value6nameOfERK5Value", "pvxs::Value::nameOf"], [19, 2, 1, "_CPPv4NK4pvxs5Value6nameOfERK5Value", "pvxs::Value::nameOf::descendant"], [19, 1, 1, "_CPPv4NK4pvxs5Value8nmembersEv", "pvxs::Value::nmembers"], [19, 1, 1, "_CPPv4I0EN4pvxs5ValueaSER5ValueRK1T", "pvxs::Value::operator="], [19, 6, 1, "_CPPv4I0EN4pvxs5ValueaSER5ValueRK1T", "pvxs::Value::operator=::T"], [19, 2, 1, "_CPPv4I0EN4pvxs5ValueaSER5ValueRK1T", "pvxs::Value::operator=::val"], [19, 1, 1, "_CPPv4N4pvxs5ValueixERKNSt6stringE", "pvxs::Value::operator[]"], [19, 2, 1, "_CPPv4N4pvxs5ValueixERKNSt6stringE", "pvxs::Value::operator[]::name"], [19, 1, 1, "_CPPv4NK4pvxs5Value11storageTypeEv", "pvxs::Value::storageType"], [19, 1, 1, "_CPPv4I0EN4pvxs5Value7tryFromEbRK1T", "pvxs::Value::tryFrom"], [19, 6, 1, "_CPPv4I0EN4pvxs5Value7tryFromEbRK1T", "pvxs::Value::tryFrom::T"], [19, 2, 1, "_CPPv4I0EN4pvxs5Value7tryFromEbRK1T", "pvxs::Value::tryFrom::val"], [19, 1, 1, "_CPPv4NK4pvxs5Value4typeEv", "pvxs::Value::type"], [19, 1, 1, "_CPPv4N4pvxs5Value6unmarkEbb", "pvxs::Value::unmark"], [19, 2, 1, "_CPPv4N4pvxs5Value6unmarkEbb", "pvxs::Value::unmark::children"], [19, 2, 1, "_CPPv4N4pvxs5Value6unmarkEbb", "pvxs::Value::unmark::parents"], [19, 1, 1, "_CPPv4I00EN4pvxs5Value6updateER5Value1KRK1T", "pvxs::Value::update"], [19, 6, 1, "_CPPv4I00EN4pvxs5Value6updateER5Value1KRK1T", "pvxs::Value::update::K"], [19, 6, 1, "_CPPv4I00EN4pvxs5Value6updateER5Value1KRK1T", "pvxs::Value::update::T"], [19, 2, 1, "_CPPv4I00EN4pvxs5Value6updateER5Value1KRK1T", "pvxs::Value::update::key"], [19, 2, 1, "_CPPv4I00EN4pvxs5Value6updateER5Value1KRK1T", "pvxs::Value::update::val"], [19, 1, 1, "_CPPv4NK4pvxs5Value5validEv", "pvxs::Value::valid"], [18, 1, 1, "_CPPv4N4pvxs20cleanup_for_valgrindEv", "pvxs::cleanup_for_valgrind"], [2, 5, 1, "_CPPv4N4pvxs6client6ConfigE", "pvxs::client::Config"], [2, 8, 1, "_CPPv4N4pvxs6client6Config11addressListE", "pvxs::client::Config::addressList"], [2, 1, 1, "_CPPv4N4pvxs6client6Config9applyDefsERK6defs_t", "pvxs::client::Config::applyDefs"], [2, 2, 1, "_CPPv4N4pvxs6client6Config9applyDefsERK6defs_t", "pvxs::client::Config::applyDefs::defs"], [2, 1, 1, "_CPPv4N4pvxs6client6Config8applyEnvEv", "pvxs::client::Config::applyEnv"], [2, 8, 1, "_CPPv4N4pvxs6client6Config12autoAddrListE", "pvxs::client::Config::autoAddrList"], [2, 1, 1, "_CPPv4NK4pvxs6client6Config5buildEv", "pvxs::client::Config::build"], [2, 1, 1, "_CPPv4N4pvxs6client6Config6expandEv", "pvxs::client::Config::expand"], [2, 1, 1, "_CPPv4N4pvxs6client6Config7fromEnvEv", "pvxs::client::Config::fromEnv"], [2, 8, 1, "_CPPv4N4pvxs6client6Config10interfacesE", "pvxs::client::Config::interfaces"], [2, 8, 1, "_CPPv4N4pvxs6client6Config11nameServersE", "pvxs::client::Config::nameServers"], [2, 8, 1, "_CPPv4N4pvxs6client6Config10tcpTimeoutE", "pvxs::client::Config::tcpTimeout"], [2, 8, 1, "_CPPv4N4pvxs6client6Config8tcp_portE", "pvxs::client::Config::tcp_port"], [2, 8, 1, "_CPPv4N4pvxs6client6Config8udp_portE", "pvxs::client::Config::udp_port"], [2, 1, 1, "_CPPv4NK4pvxs6client6Config10updateDefsER6defs_t", "pvxs::client::Config::updateDefs"], [2, 2, 1, "_CPPv4NK4pvxs6client6Config10updateDefsER6defs_t", "pvxs::client::Config::updateDefs::defs"], [2, 5, 1, "_CPPv4N4pvxs6client7ConnectE", "pvxs::client::Connect"], [2, 1, 1, "_CPPv4NK4pvxs6client7Connect9connectedEv", "pvxs::client::Connect::connected"], [2, 1, 1, "_CPPv4NK4pvxs6client7Connect4nameEv", "pvxs::client::Connect::name"], [2, 5, 1, "_CPPv4N4pvxs6client14ConnectBuilderE", "pvxs::client::ConnectBuilder"], [2, 1, 1, "_CPPv4N4pvxs6client14ConnectBuilder4execEv", "pvxs::client::ConnectBuilder::exec"], [2, 1, 1, "_CPPv4N4pvxs6client14ConnectBuilder9onConnectERRNSt8functionIFvvEEE", "pvxs::client::ConnectBuilder::onConnect"], [2, 2, 1, "_CPPv4N4pvxs6client14ConnectBuilder9onConnectERRNSt8functionIFvvEEE", "pvxs::client::ConnectBuilder::onConnect::cb"], [2, 1, 1, "_CPPv4N4pvxs6client14ConnectBuilder12onDisconnectERRNSt8functionIFvvEEE", "pvxs::client::ConnectBuilder::onDisconnect"], [2, 2, 1, "_CPPv4N4pvxs6client14ConnectBuilder12onDisconnectERRNSt8functionIFvvEEE", "pvxs::client::ConnectBuilder::onDisconnect::cb"], [2, 1, 1, "_CPPv4N4pvxs6client14ConnectBuilder10syncCancelEb", "pvxs::client::ConnectBuilder::syncCancel"], [2, 2, 1, "_CPPv4N4pvxs6client14ConnectBuilder10syncCancelEb", "pvxs::client::ConnectBuilder::syncCancel::b"], [2, 5, 1, "_CPPv4N4pvxs6client9ConnectedE", "pvxs::client::Connected"], [2, 5, 1, "_CPPv4N4pvxs6client7ContextE", "pvxs::client::Context"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7ContextERK6Config", "pvxs::client::Context::Context"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7ContextEv", "pvxs::client::Context::Context"], [2, 1, 1, "_CPPv4N4pvxs6client7Context5closeEv", "pvxs::client::Context::close"], [2, 1, 1, "_CPPv4NK4pvxs6client7Context6configEv", "pvxs::client::Context::config"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7connectERKNSt6stringE", "pvxs::client::Context::connect"], [2, 2, 1, "_CPPv4N4pvxs6client7Context7connectERKNSt6stringE", "pvxs::client::Context::connect::pvname"], [2, 1, 1, "_CPPv4N4pvxs6client7Context8discoverERRNSt8functionIFvRK10DiscoveredEEE", "pvxs::client::Context::discover"], [2, 2, 1, "_CPPv4N4pvxs6client7Context8discoverERRNSt8functionIFvRK10DiscoveredEEE", "pvxs::client::Context::discover::fn"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7fromEnvEv", "pvxs::client::Context::fromEnv"], [2, 1, 1, "_CPPv4N4pvxs6client7Context3getERKNSt6stringE", "pvxs::client::Context::get"], [2, 2, 1, "_CPPv4N4pvxs6client7Context3getERKNSt6stringE", "pvxs::client::Context::get::pvname"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7hurryUpEv", "pvxs::client::Context::hurryUp"], [2, 1, 1, "_CPPv4N4pvxs6client7Context4infoERKNSt6stringE", "pvxs::client::Context::info"], [2, 2, 1, "_CPPv4N4pvxs6client7Context4infoERKNSt6stringE", "pvxs::client::Context::info::pvname"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7monitorERKNSt6stringE", "pvxs::client::Context::monitor"], [2, 2, 1, "_CPPv4N4pvxs6client7Context7monitorERKNSt6stringE", "pvxs::client::Context::monitor::pvname"], [2, 1, 1, "_CPPv4N4pvxs6client7Context3putERKNSt6stringE", "pvxs::client::Context::put"], [2, 2, 1, "_CPPv4N4pvxs6client7Context3putERKNSt6stringE", "pvxs::client::Context::put::pvname"], [2, 1, 1, "_CPPv4N4pvxs6client7Context7requestEv", "pvxs::client::Context::request"], [2, 1, 1, "_CPPv4N4pvxs6client7Context3rpcERKNSt6stringERK5Value", "pvxs::client::Context::rpc"], [2, 2, 1, "_CPPv4N4pvxs6client7Context3rpcERKNSt6stringERK5Value", "pvxs::client::Context::rpc::arg"], [2, 2, 1, "_CPPv4N4pvxs6client7Context3rpcERKNSt6stringERK5Value", "pvxs::client::Context::rpc::pvname"], [2, 5, 1, "_CPPv4N4pvxs6client10DisconnectE", "pvxs::client::Disconnect"], [2, 8, 1, "_CPPv4N4pvxs6client10Disconnect4timeE", "pvxs::client::Disconnect::time"], [2, 5, 1, "_CPPv4N4pvxs6client8FinishedE", "pvxs::client::Finished"], [2, 5, 1, "_CPPv4N4pvxs6client10GetBuilderE", "pvxs::client::GetBuilder"], [2, 1, 1, "_CPPv4N4pvxs6client10GetBuilder4execEv", "pvxs::client::GetBuilder::exec"], [2, 1, 1, "_CPPv4N4pvxs6client10GetBuilder6resultERRNSt8functionIFvRR6ResultEEE", "pvxs::client::GetBuilder::result"], [2, 2, 1, "_CPPv4N4pvxs6client10GetBuilder6resultERRNSt8functionIFvRR6ResultEEE", "pvxs::client::GetBuilder::result::cb"], [2, 5, 1, "_CPPv4N4pvxs6client14MonitorBuilderE", "pvxs::client::MonitorBuilder"], [2, 1, 1, "_CPPv4N4pvxs6client14MonitorBuilder5eventERRNSt8functionIFvR12SubscriptionEEE", "pvxs::client::MonitorBuilder::event"], [2, 2, 1, "_CPPv4N4pvxs6client14MonitorBuilder5eventERRNSt8functionIFvR12SubscriptionEEE", "pvxs::client::MonitorBuilder::event::cb"], [2, 1, 1, "_CPPv4N4pvxs6client14MonitorBuilder4execEv", "pvxs::client::MonitorBuilder::exec"], [2, 1, 1, "_CPPv4N4pvxs6client14MonitorBuilder13maskConnectedEb", "pvxs::client::MonitorBuilder::maskConnected"], [2, 2, 1, "_CPPv4N4pvxs6client14MonitorBuilder13maskConnectedEb", "pvxs::client::MonitorBuilder::maskConnected::m"], [2, 1, 1, "_CPPv4N4pvxs6client14MonitorBuilder16maskDisconnectedEb", "pvxs::client::MonitorBuilder::maskDisconnected"], [2, 2, 1, "_CPPv4N4pvxs6client14MonitorBuilder16maskDisconnectedEb", "pvxs::client::MonitorBuilder::maskDisconnected::m"], [2, 5, 1, "_CPPv4N4pvxs6client9OperationE", "pvxs::client::Operation"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t8DiscoverE", "pvxs::client::Operation::Discover"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t3GetE", "pvxs::client::Operation::Get"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t4InfoE", "pvxs::client::Operation::Info"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t7MonitorE", "pvxs::client::Operation::Monitor"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t3PutE", "pvxs::client::Operation::Put"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t3RPCE", "pvxs::client::Operation::RPC"], [2, 1, 1, "_CPPv4N4pvxs6client9Operation6cancelEv", "pvxs::client::Operation::cancel"], [2, 1, 1, "_CPPv4N4pvxs6client9Operation9interruptEv", "pvxs::client::Operation::interrupt"], [2, 1, 1, "_CPPv4N4pvxs6client9Operation4nameEv", "pvxs::client::Operation::name"], [2, 3, 1, "_CPPv4N4pvxs6client9Operation11operation_tE", "pvxs::client::Operation::operation_t"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t8DiscoverE", "pvxs::client::Operation::operation_t::Discover"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t3GetE", "pvxs::client::Operation::operation_t::Get"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t4InfoE", "pvxs::client::Operation::operation_t::Info"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t7MonitorE", "pvxs::client::Operation::operation_t::Monitor"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t3PutE", "pvxs::client::Operation::operation_t::Put"], [2, 4, 1, "_CPPv4N4pvxs6client9Operation11operation_t3RPCE", "pvxs::client::Operation::operation_t::RPC"], [2, 1, 1, "_CPPv4N4pvxs6client9Operation4waitEd", "pvxs::client::Operation::wait"], [2, 1, 1, "_CPPv4N4pvxs6client9Operation4waitEv", "pvxs::client::Operation::wait"], [2, 2, 1, "_CPPv4N4pvxs6client9Operation4waitEd", "pvxs::client::Operation::wait::timeout"], [2, 5, 1, "_CPPv4N4pvxs6client10PutBuilderE", "pvxs::client::PutBuilder"], [2, 1, 1, "_CPPv4N4pvxs6client10PutBuilder5buildERRNSt8functionIF5ValueRR5ValueEEE", "pvxs::client::PutBuilder::build"], [2, 2, 1, "_CPPv4N4pvxs6client10PutBuilder5buildERRNSt8functionIF5ValueRR5ValueEEE", "pvxs::client::PutBuilder::build::cb"], [2, 1, 1, "_CPPv4N4pvxs6client10PutBuilder4execEv", "pvxs::client::PutBuilder::exec"], [2, 1, 1, "_CPPv4N4pvxs6client10PutBuilder12fetchPresentEb", "pvxs::client::PutBuilder::fetchPresent"], [2, 2, 1, "_CPPv4N4pvxs6client10PutBuilder12fetchPresentEb", "pvxs::client::PutBuilder::fetchPresent::f"], [2, 1, 1, "_CPPv4N4pvxs6client10PutBuilder6resultERRNSt8functionIFvRR6ResultEEE", "pvxs::client::PutBuilder::result"], [2, 2, 1, "_CPPv4N4pvxs6client10PutBuilder6resultERRNSt8functionIFvRR6ResultEEE", "pvxs::client::PutBuilder::result::cb"], [2, 1, 1, "_CPPv4I0EN4pvxs6client10PutBuilder3setER10PutBuilderRKNSt6stringERK1Tb", "pvxs::client::PutBuilder::set"], [2, 6, 1, "_CPPv4I0EN4pvxs6client10PutBuilder3setER10PutBuilderRKNSt6stringERK1Tb", "pvxs::client::PutBuilder::set::T"], [2, 2, 1, "_CPPv4I0EN4pvxs6client10PutBuilder3setER10PutBuilderRKNSt6stringERK1Tb", "pvxs::client::PutBuilder::set::name"], [2, 2, 1, "_CPPv4I0EN4pvxs6client10PutBuilder3setER10PutBuilderRKNSt6stringERK1Tb", "pvxs::client::PutBuilder::set::required"], [2, 2, 1, "_CPPv4I0EN4pvxs6client10PutBuilder3setER10PutBuilderRKNSt6stringERK1Tb", "pvxs::client::PutBuilder::set::val"], [2, 5, 1, "_CPPv4N4pvxs6client10RPCBuilderE", "pvxs::client::RPCBuilder"], [2, 1, 1, "_CPPv4I0EN4pvxs6client10RPCBuilder3argER10RPCBuilderRKNSt6stringERK1T", "pvxs::client::RPCBuilder::arg"], [2, 6, 1, "_CPPv4I0EN4pvxs6client10RPCBuilder3argER10RPCBuilderRKNSt6stringERK1T", "pvxs::client::RPCBuilder::arg::T"], [2, 2, 1, "_CPPv4I0EN4pvxs6client10RPCBuilder3argER10RPCBuilderRKNSt6stringERK1T", "pvxs::client::RPCBuilder::arg::name"], [2, 2, 1, "_CPPv4I0EN4pvxs6client10RPCBuilder3argER10RPCBuilderRKNSt6stringERK1T", "pvxs::client::RPCBuilder::arg::val"], [2, 1, 1, "_CPPv4N4pvxs6client10RPCBuilder4execEv", "pvxs::client::RPCBuilder::exec"], [2, 1, 1, "_CPPv4N4pvxs6client10RPCBuilder6resultERRNSt8functionIFvRR6ResultEEE", "pvxs::client::RPCBuilder::result"], [2, 2, 1, "_CPPv4N4pvxs6client10RPCBuilder6resultERRNSt8functionIFvRR6ResultEEE", "pvxs::client::RPCBuilder::result::cb"], [2, 5, 1, "_CPPv4N4pvxs6client11RemoteErrorE", "pvxs::client::RemoteError"], [2, 5, 1, "_CPPv4N4pvxs6client6ResultE", "pvxs::client::Result"], [2, 1, 1, "_CPPv4N4pvxs6client6ResultclEv", "pvxs::client::Result::operator()"], [2, 5, 1, "_CPPv4N4pvxs6client12SubscriptionE", "pvxs::client::Subscription"], [2, 1, 1, "_CPPv4N4pvxs6client12Subscription6cancelEv", "pvxs::client::Subscription::cancel"], [2, 1, 1, "_CPPv4N4pvxs6client12Subscription4nameEv", "pvxs::client::Subscription::name"], [2, 1, 1, "_CPPv4N4pvxs6client12Subscription5pauseEb", "pvxs::client::Subscription::pause"], [2, 2, 1, "_CPPv4N4pvxs6client12Subscription5pauseEb", "pvxs::client::Subscription::pause::p"], [2, 1, 1, "_CPPv4N4pvxs6client12Subscription3popEv", "pvxs::client::Subscription::pop"], [2, 1, 1, "_CPPv4N4pvxs6client12Subscription6resumeEv", "pvxs::client::Subscription::resume"], [2, 1, 1, "_CPPv4NK4pvxs6client12Subscription16shared_from_thisEv", "pvxs::client::Subscription::shared_from_this"], [2, 1, 1, "_CPPv4N4pvxs6client12Subscription5statsER16SubscriptionStatb", "pvxs::client::Subscription::stats"], [2, 2, 1, "_CPPv4N4pvxs6client12Subscription5statsER16SubscriptionStatb", "pvxs::client::Subscription::stats::reset"], [2, 5, 1, "_CPPv4I00EN4pvxs6client6detail13CommonBuilderE", "pvxs::client::detail::CommonBuilder"], [2, 6, 1, "_CPPv4I00EN4pvxs6client6detail13CommonBuilderE", "pvxs::client::detail::CommonBuilder::Base"], [2, 6, 1, "_CPPv4I00EN4pvxs6client6detail13CommonBuilderE", "pvxs::client::detail::CommonBuilder::SubBuilder"], [2, 1, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder5fieldERKNSt6stringE", "pvxs::client::detail::CommonBuilder::field"], [2, 2, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder5fieldERKNSt6stringE", "pvxs::client::detail::CommonBuilder::field::fld"], [2, 1, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder9pvRequestERKNSt6stringE", "pvxs::client::detail::CommonBuilder::pvRequest"], [2, 2, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder9pvRequestERKNSt6stringE", "pvxs::client::detail::CommonBuilder::pvRequest::expr"], [2, 1, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder10rawRequestERK5Value", "pvxs::client::detail::CommonBuilder::rawRequest"], [2, 2, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder10rawRequestERK5Value", "pvxs::client::detail::CommonBuilder::rawRequest::r"], [2, 1, 1, "_CPPv4I0EN4pvxs6client6detail13CommonBuilder6recordER10SubBuilderRKNSt6stringERK1T", "pvxs::client::detail::CommonBuilder::record"], [2, 6, 1, "_CPPv4I0EN4pvxs6client6detail13CommonBuilder6recordER10SubBuilderRKNSt6stringERK1T", "pvxs::client::detail::CommonBuilder::record::T"], [2, 2, 1, "_CPPv4I0EN4pvxs6client6detail13CommonBuilder6recordER10SubBuilderRKNSt6stringERK1T", "pvxs::client::detail::CommonBuilder::record::name"], [2, 2, 1, "_CPPv4I0EN4pvxs6client6detail13CommonBuilder6recordER10SubBuilderRKNSt6stringERK1T", "pvxs::client::detail::CommonBuilder::record::val"], [2, 1, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder10syncCancelEb", "pvxs::client::detail::CommonBuilder::syncCancel"], [2, 2, 1, "_CPPv4N4pvxs6client6detail13CommonBuilder10syncCancelEb", "pvxs::client::detail::CommonBuilder::syncCancel::b"], [19, 5, 1, "_CPPv4N4pvxs6detail7LimiterE", "pvxs::detail::Limiter"], [19, 1, 1, "_CPPv4N4pvxs6detail7Limiter5limitE6size_t", "pvxs::detail::Limiter::limit"], [19, 2, 1, "_CPPv4N4pvxs6detail7Limiter5limitE6size_t", "pvxs::detail::Limiter::limit::l"], [19, 1, 1, "_CPPv4N4pvxs11elementSizeE9ArrayType", "pvxs::elementSize"], [19, 2, 1, "_CPPv4N4pvxs11elementSizeE9ArrayType", "pvxs::elementSize::type"], [18, 1, 1, "_CPPv4N4pvxs6escapeEPKc", "pvxs::escape"], [18, 1, 1, "_CPPv4N4pvxs6escapeEPKc6size_t", "pvxs::escape"], [18, 1, 1, "_CPPv4N4pvxs6escapeERKNSt6stringE", "pvxs::escape"], [18, 2, 1, "_CPPv4N4pvxs6escapeEPKc6size_t", "pvxs::escape::n"], [18, 2, 1, "_CPPv4N4pvxs6escapeEPKc", "pvxs::escape::s"], [18, 2, 1, "_CPPv4N4pvxs6escapeEPKc6size_t", "pvxs::escape::s"], [18, 2, 1, "_CPPv4N4pvxs6escapeERKNSt6stringE", "pvxs::escape::s"], [18, 5, 1, "_CPPv4N4pvxs3ioc7TestIOCE", "pvxs::ioc::TestIOC"], [6, 1, 1, "_CPPv4N4pvxs3ioc6serverEv", "pvxs::ioc::server"], [18, 5, 1, "_CPPv4N4pvxs6loggerE", "pvxs::logger"], [18, 8, 1, "_CPPv4N4pvxs6logger3lvlE", "pvxs::logger::lvl"], [18, 8, 1, "_CPPv4N4pvxs6logger4nameE", "pvxs::logger::name"], [18, 1, 1, "_CPPv4N4pvxs6logger4testE5Level", "pvxs::logger::test"], [18, 2, 1, "_CPPv4N4pvxs6logger4testE5Level", "pvxs::logger::test::lvl"], [18, 1, 1, "_CPPv4N4pvxs17logger_config_envEv", "pvxs::logger_config_env"], [18, 1, 1, "_CPPv4N4pvxs18logger_level_clearEv", "pvxs::logger_level_clear"], [18, 1, 1, "_CPPv4N4pvxs16logger_level_setEPKc5Level", "pvxs::logger_level_set"], [18, 2, 1, "_CPPv4N4pvxs16logger_level_setEPKc5Level", "pvxs::logger_level_set::lvl"], [18, 2, 1, "_CPPv4N4pvxs16logger_level_setEPKc5Level", "pvxs::logger_level_set::name"], [17, 7, 1, "_CPPv4N4pvxs7membersE", "pvxs::members"], [8, 5, 1, "_CPPv4N4pvxs2nt5AlarmE", "pvxs::nt::Alarm"], [8, 5, 1, "_CPPv4N4pvxs2nt6NTEnumE", "pvxs::nt::NTEnum"], [8, 1, 1, "_CPPv4NK4pvxs2nt6NTEnum5buildEv", "pvxs::nt::NTEnum::build"], [8, 1, 1, "_CPPv4NK4pvxs2nt6NTEnum6createEv", "pvxs::nt::NTEnum::create"], [8, 5, 1, "_CPPv4N4pvxs2nt9NTNDArrayE", "pvxs::nt::NTNDArray"], [8, 1, 1, "_CPPv4NK4pvxs2nt9NTNDArray5buildEv", "pvxs::nt::NTNDArray::build"], [8, 1, 1, "_CPPv4NK4pvxs2nt9NTNDArray6createEv", "pvxs::nt::NTNDArray::create"], [9, 5, 1, "_CPPv4N4pvxs2nt8NTScalarE", "pvxs::nt::NTScalar"], [9, 1, 1, "_CPPv4NK4pvxs2nt8NTScalar5buildEv", "pvxs::nt::NTScalar::build"], [9, 8, 1, "_CPPv4N4pvxs2nt8NTScalar7controlE", "pvxs::nt::NTScalar::control"], [9, 1, 1, "_CPPv4NK4pvxs2nt8NTScalar6createEv", "pvxs::nt::NTScalar::create"], [9, 8, 1, "_CPPv4N4pvxs2nt8NTScalar7displayE", "pvxs::nt::NTScalar::display"], [9, 8, 1, "_CPPv4N4pvxs2nt8NTScalar4formE", "pvxs::nt::NTScalar::form"], [9, 8, 1, "_CPPv4N4pvxs2nt8NTScalar5valueE", "pvxs::nt::NTScalar::value"], [9, 8, 1, "_CPPv4N4pvxs2nt8NTScalar10valueAlarmE", "pvxs::nt::NTScalar::valueAlarm"], [8, 5, 1, "_CPPv4N4pvxs2nt7NTTableE", "pvxs::nt::NTTable"], [8, 1, 1, "_CPPv4N4pvxs2nt7NTTable10add_columnE8TypeCodePKcPKc", "pvxs::nt::NTTable::add_column"], [8, 2, 1, "_CPPv4N4pvxs2nt7NTTable10add_columnE8TypeCodePKcPKc", "pvxs::nt::NTTable::add_column::code"], [8, 2, 1, "_CPPv4N4pvxs2nt7NTTable10add_columnE8TypeCodePKcPKc", "pvxs::nt::NTTable::add_column::label"], [8, 2, 1, "_CPPv4N4pvxs2nt7NTTable10add_columnE8TypeCodePKcPKc", "pvxs::nt::NTTable::add_column::name"], [8, 1, 1, "_CPPv4NK4pvxs2nt7NTTable5buildEv", "pvxs::nt::NTTable::build"], [8, 1, 1, "_CPPv4NK4pvxs2nt7NTTable6createEv", "pvxs::nt::NTTable::create"], [8, 5, 1, "_CPPv4N4pvxs2nt5NTURIE", "pvxs::nt::NTURI"], [8, 1, 1, "_CPPv4NK4pvxs2nt5NTURI5buildEv", "pvxs::nt::NTURI::build"], [8, 1, 1, "_CPPv4NK4pvxs2nt5NTURI6createEv", "pvxs::nt::NTURI::create"], [8, 5, 1, "_CPPv4N4pvxs2nt9TimeStampE", "pvxs::nt::TimeStamp"], [16, 5, 1, "_CPPv4N4pvxs6server14ChannelControlE", "pvxs::server::ChannelControl"], [16, 1, 1, "_CPPv4N4pvxs6server14ChannelControl5closeEv", "pvxs::server::ChannelControl::close"], [16, 1, 1, "_CPPv4N4pvxs6server14ChannelControl7onCloseERRNSt8functionIFvRKNSt6stringEEEE", "pvxs::server::ChannelControl::onClose"], [16, 1, 1, "_CPPv4N4pvxs6server14ChannelControl4onOpERRNSt8functionIFvRRNSt10unique_ptrI9ConnectOpEEEEE", "pvxs::server::ChannelControl::onOp"], [16, 1, 1, "_CPPv4N4pvxs6server14ChannelControl5onRPCERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::ChannelControl::onRPC"], [16, 2, 1, "_CPPv4N4pvxs6server14ChannelControl5onRPCERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::ChannelControl::onRPC::fn"], [16, 1, 1, "_CPPv4N4pvxs6server14ChannelControl11onSubscribeERRNSt8functionIFvRRNSt10unique_ptrI14MonitorSetupOpEEEEE", "pvxs::server::ChannelControl::onSubscribe"], [16, 5, 1, "_CPPv4N4pvxs6server17ClientCredentialsE", "pvxs::server::ClientCredentials"], [16, 8, 1, "_CPPv4N4pvxs6server17ClientCredentials7accountE", "pvxs::server::ClientCredentials::account"], [16, 8, 1, "_CPPv4N4pvxs6server17ClientCredentials5ifaceE", "pvxs::server::ClientCredentials::iface"], [16, 8, 1, "_CPPv4N4pvxs6server17ClientCredentials6methodE", "pvxs::server::ClientCredentials::method"], [16, 8, 1, "_CPPv4N4pvxs6server17ClientCredentials4peerE", "pvxs::server::ClientCredentials::peer"], [16, 8, 1, "_CPPv4N4pvxs6server17ClientCredentials3rawE", "pvxs::server::ClientCredentials::raw"], [16, 1, 1, "_CPPv4NK4pvxs6server17ClientCredentials5rolesEv", "pvxs::server::ClientCredentials::roles"], [14, 5, 1, "_CPPv4N4pvxs6server6ConfigE", "pvxs::server::Config"], [14, 1, 1, "_CPPv4N4pvxs6server6Config9applyDefsERK6defs_t", "pvxs::server::Config::applyDefs"], [14, 2, 1, "_CPPv4N4pvxs6server6Config9applyDefsERK6defs_t", "pvxs::server::Config::applyDefs::def"], [14, 1, 1, "_CPPv4N4pvxs6server6Config8applyEnvEv", "pvxs::server::Config::applyEnv"], [14, 8, 1, "_CPPv4N4pvxs6server6Config11auto_beaconE", "pvxs::server::Config::auto_beacon"], [14, 8, 1, "_CPPv4N4pvxs6server6Config18beaconDestinationsE", "pvxs::server::Config::beaconDestinations"], [14, 1, 1, "_CPPv4NK4pvxs6server6Config5buildEv", "pvxs::server::Config::build"], [14, 1, 1, "_CPPv4N4pvxs6server6Config6expandEv", "pvxs::server::Config::expand"], [14, 1, 1, "_CPPv4N4pvxs6server6Config7fromEnvEv", "pvxs::server::Config::fromEnv"], [14, 8, 1, "_CPPv4N4pvxs6server6Config4guidE", "pvxs::server::Config::guid"], [14, 8, 1, "_CPPv4N4pvxs6server6Config11ignoreAddrsE", "pvxs::server::Config::ignoreAddrs"], [14, 8, 1, "_CPPv4N4pvxs6server6Config10interfacesE", "pvxs::server::Config::interfaces"], [14, 1, 1, "_CPPv4N4pvxs6server6Config8isolatedEi", "pvxs::server::Config::isolated"], [14, 2, 1, "_CPPv4N4pvxs6server6Config8isolatedEi", "pvxs::server::Config::isolated::family"], [14, 8, 1, "_CPPv4N4pvxs6server6Config10tcpTimeoutE", "pvxs::server::Config::tcpTimeout"], [14, 8, 1, "_CPPv4N4pvxs6server6Config8tcp_portE", "pvxs::server::Config::tcp_port"], [14, 8, 1, "_CPPv4N4pvxs6server6Config8udp_portE", "pvxs::server::Config::udp_port"], [14, 1, 1, "_CPPv4NK4pvxs6server6Config10updateDefsER6defs_t", "pvxs::server::Config::updateDefs"], [14, 2, 1, "_CPPv4NK4pvxs6server6Config10updateDefsER6defs_t", "pvxs::server::Config::updateDefs::defs"], [16, 5, 1, "_CPPv4N4pvxs6server9ConnectOpE", "pvxs::server::ConnectOp"], [16, 1, 1, "_CPPv4N4pvxs6server9ConnectOp7connectERK5Value", "pvxs::server::ConnectOp::connect"], [16, 2, 1, "_CPPv4N4pvxs6server9ConnectOp7connectERK5Value", "pvxs::server::ConnectOp::connect::prototype"], [16, 1, 1, "_CPPv4N4pvxs6server9ConnectOp5errorERKNSt6stringE", "pvxs::server::ConnectOp::error"], [16, 2, 1, "_CPPv4N4pvxs6server9ConnectOp5errorERKNSt6stringE", "pvxs::server::ConnectOp::error::msg"], [16, 1, 1, "_CPPv4N4pvxs6server9ConnectOp7onCloseERRNSt8functionIFvRKNSt6stringEEEE", "pvxs::server::ConnectOp::onClose"], [16, 1, 1, "_CPPv4N4pvxs6server9ConnectOp5onGetERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEEEEE", "pvxs::server::ConnectOp::onGet"], [16, 2, 1, "_CPPv4N4pvxs6server9ConnectOp5onGetERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEEEEE", "pvxs::server::ConnectOp::onGet::fn"], [16, 1, 1, "_CPPv4N4pvxs6server9ConnectOp5onPutERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::ConnectOp::onPut"], [16, 2, 1, "_CPPv4N4pvxs6server9ConnectOp5onPutERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::ConnectOp::onPut::fn"], [16, 5, 1, "_CPPv4N4pvxs6server6ExecOpE", "pvxs::server::ExecOp"], [16, 1, 1, "_CPPv4N4pvxs6server6ExecOp5errorERKNSt6stringE", "pvxs::server::ExecOp::error"], [16, 2, 1, "_CPPv4N4pvxs6server6ExecOp5errorERKNSt6stringE", "pvxs::server::ExecOp::error::msg"], [16, 1, 1, "_CPPv4N4pvxs6server6ExecOp8onCancelERRNSt8functionIFvvEEE", "pvxs::server::ExecOp::onCancel"], [16, 1, 1, "_CPPv4NK4pvxs6server6ExecOp9pvRequestEv", "pvxs::server::ExecOp::pvRequest"], [16, 1, 1, "_CPPv4N4pvxs6server6ExecOp5replyERK5Value", "pvxs::server::ExecOp::reply"], [16, 1, 1, "_CPPv4N4pvxs6server6ExecOp5replyEv", "pvxs::server::ExecOp::reply"], [16, 2, 1, "_CPPv4N4pvxs6server6ExecOp5replyERK5Value", "pvxs::server::ExecOp::reply::val"], [16, 5, 1, "_CPPv4N4pvxs6server16MonitorControlOpE", "pvxs::server::MonitorControlOp"], [16, 1, 1, "_CPPv4N4pvxs6server16MonitorControlOp6finishEv", "pvxs::server::MonitorControlOp::finish"], [16, 1, 1, "_CPPv4N4pvxs6server16MonitorControlOp9forcePostERK5Value", "pvxs::server::MonitorControlOp::forcePost"], [16, 2, 1, "_CPPv4N4pvxs6server16MonitorControlOp9forcePostERK5Value", "pvxs::server::MonitorControlOp::forcePost::val"], [16, 1, 1, "_CPPv4N4pvxs6server16MonitorControlOp7onStartERRNSt8functionIFvbEEE", "pvxs::server::MonitorControlOp::onStart"], [16, 1, 1, "_CPPv4N4pvxs6server16MonitorControlOp4postERK5Value", "pvxs::server::MonitorControlOp::post"], [16, 2, 1, "_CPPv4N4pvxs6server16MonitorControlOp4postERK5Value", "pvxs::server::MonitorControlOp::post::val"], [16, 1, 1, "_CPPv4N4pvxs6server16MonitorControlOp13setWatermarksE6size_t6size_t", "pvxs::server::MonitorControlOp::setWatermarks"], [16, 2, 1, "_CPPv4N4pvxs6server16MonitorControlOp13setWatermarksE6size_t6size_t", "pvxs::server::MonitorControlOp::setWatermarks::high"], [16, 2, 1, "_CPPv4N4pvxs6server16MonitorControlOp13setWatermarksE6size_t6size_t", "pvxs::server::MonitorControlOp::setWatermarks::low"], [16, 1, 1, "_CPPv4NK4pvxs6server16MonitorControlOp5statsER11MonitorStatb", "pvxs::server::MonitorControlOp::stats"], [16, 2, 1, "_CPPv4NK4pvxs6server16MonitorControlOp5statsER11MonitorStatb", "pvxs::server::MonitorControlOp::stats::reset"], [16, 1, 1, "_CPPv4N4pvxs6server16MonitorControlOp7tryPostERK5Value", "pvxs::server::MonitorControlOp::tryPost"], [16, 2, 1, "_CPPv4N4pvxs6server16MonitorControlOp7tryPostERK5Value", "pvxs::server::MonitorControlOp::tryPost::val"], [16, 5, 1, "_CPPv4N4pvxs6server14MonitorSetupOpE", "pvxs::server::MonitorSetupOp"], [16, 1, 1, "_CPPv4N4pvxs6server14MonitorSetupOp7connectERK5Value", "pvxs::server::MonitorSetupOp::connect"], [16, 2, 1, "_CPPv4N4pvxs6server14MonitorSetupOp7connectERK5Value", "pvxs::server::MonitorSetupOp::connect::prototype"], [16, 1, 1, "_CPPv4N4pvxs6server14MonitorSetupOp5errorERKNSt6stringE", "pvxs::server::MonitorSetupOp::error"], [16, 2, 1, "_CPPv4N4pvxs6server14MonitorSetupOp5errorERKNSt6stringE", "pvxs::server::MonitorSetupOp::error::msg"], [16, 5, 1, "_CPPv4N4pvxs6server11MonitorStatE", "pvxs::server::MonitorStat"], [16, 8, 1, "_CPPv4N4pvxs6server11MonitorStat10limitQueueE", "pvxs::server::MonitorStat::limitQueue"], [16, 8, 1, "_CPPv4N4pvxs6server11MonitorStat8maxQueueE", "pvxs::server::MonitorStat::maxQueue"], [16, 8, 1, "_CPPv4N4pvxs6server11MonitorStat6nQueueE", "pvxs::server::MonitorStat::nQueue"], [16, 8, 1, "_CPPv4N4pvxs6server11MonitorStat7nSquashE", "pvxs::server::MonitorStat::nSquash"], [16, 8, 1, "_CPPv4N4pvxs6server11MonitorStat6windowE", "pvxs::server::MonitorStat::window"], [16, 5, 1, "_CPPv4N4pvxs6server6OpBaseE", "pvxs::server::OpBase"], [16, 1, 1, "_CPPv4NK4pvxs6server6OpBase11credentialsEv", "pvxs::server::OpBase::credentials"], [16, 1, 1, "_CPPv4NK4pvxs6server6OpBase4nameEv", "pvxs::server::OpBase::name"], [16, 1, 1, "_CPPv4NK4pvxs6server6OpBase2opEv", "pvxs::server::OpBase::op"], [16, 1, 1, "_CPPv4NK4pvxs6server6OpBase8peerNameEv", "pvxs::server::OpBase::peerName"], [14, 5, 1, "_CPPv4N4pvxs6server6ServerE", "pvxs::server::Server"], [14, 1, 1, "_CPPv4N4pvxs6server6Server6ServerERK6Config", "pvxs::server::Server::Server"], [14, 1, 1, "_CPPv4N4pvxs6server6Server6ServerEv", "pvxs::server::Server::Server"], [14, 1, 1, "_CPPv4N4pvxs6server6Server5addPVERKNSt6stringERK8SharedPV", "pvxs::server::Server::addPV"], [14, 2, 1, "_CPPv4N4pvxs6server6Server5addPVERKNSt6stringERK8SharedPV", "pvxs::server::Server::addPV::name"], [14, 2, 1, "_CPPv4N4pvxs6server6Server5addPVERKNSt6stringERK8SharedPV", "pvxs::server::Server::addPV::pv"], [14, 1, 1, "_CPPv4N4pvxs6server6Server9addSourceERKNSt6stringERKNSt10shared_ptrI6SourceEEi", "pvxs::server::Server::addSource"], [14, 2, 1, "_CPPv4N4pvxs6server6Server9addSourceERKNSt6stringERKNSt10shared_ptrI6SourceEEi", "pvxs::server::Server::addSource::name"], [14, 2, 1, "_CPPv4N4pvxs6server6Server9addSourceERKNSt6stringERKNSt10shared_ptrI6SourceEEi", "pvxs::server::Server::addSource::order"], [14, 2, 1, "_CPPv4N4pvxs6server6Server9addSourceERKNSt6stringERKNSt10shared_ptrI6SourceEEi", "pvxs::server::Server::addSource::src"], [14, 1, 1, "_CPPv4NK4pvxs6server6Server12clientConfigEv", "pvxs::server::Server::clientConfig"], [14, 1, 1, "_CPPv4NK4pvxs6server6Server6configEv", "pvxs::server::Server::config"], [14, 1, 1, "_CPPv4N4pvxs6server6Server7fromEnvEv", "pvxs::server::Server::fromEnv"], [14, 1, 1, "_CPPv4N4pvxs6server6Server9getSourceERKNSt6stringEi", "pvxs::server::Server::getSource"], [14, 2, 1, "_CPPv4N4pvxs6server6Server9getSourceERKNSt6stringEi", "pvxs::server::Server::getSource::name"], [14, 2, 1, "_CPPv4N4pvxs6server6Server9getSourceERKNSt6stringEi", "pvxs::server::Server::getSource::order"], [14, 1, 1, "_CPPv4N4pvxs6server6Server9interruptEv", "pvxs::server::Server::interrupt"], [14, 1, 1, "_CPPv4N4pvxs6server6Server10listSourceEv", "pvxs::server::Server::listSource"], [14, 1, 1, "_CPPv4N4pvxs6server6Server8removePVERKNSt6stringE", "pvxs::server::Server::removePV"], [14, 2, 1, "_CPPv4N4pvxs6server6Server8removePVERKNSt6stringE", "pvxs::server::Server::removePV::name"], [14, 1, 1, "_CPPv4N4pvxs6server6Server12removeSourceERKNSt6stringEi", "pvxs::server::Server::removeSource"], [14, 2, 1, "_CPPv4N4pvxs6server6Server12removeSourceERKNSt6stringEi", "pvxs::server::Server::removeSource::name"], [14, 2, 1, "_CPPv4N4pvxs6server6Server12removeSourceERKNSt6stringEi", "pvxs::server::Server::removeSource::order"], [14, 1, 1, "_CPPv4N4pvxs6server6Server3runEv", "pvxs::server::Server::run"], [14, 1, 1, "_CPPv4N4pvxs6server6Server5startEv", "pvxs::server::Server::start"], [14, 1, 1, "_CPPv4N4pvxs6server6Server4stopEv", "pvxs::server::Server::stop"], [15, 5, 1, "_CPPv4N4pvxs6server8SharedPVE", "pvxs::server::SharedPV"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV6attachERRNSt10unique_ptrI14ChannelControlEE", "pvxs::server::SharedPV::attach"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV6attachERRNSt10unique_ptrI14ChannelControlEE", "pvxs::server::SharedPV::attach::op"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV12buildMailboxEv", "pvxs::server::SharedPV::buildMailbox"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV13buildReadonlyEv", "pvxs::server::SharedPV::buildReadonly"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV5closeEv", "pvxs::server::SharedPV::close"], [15, 1, 1, "_CPPv4NK4pvxs6server8SharedPV5fetchER5Value", "pvxs::server::SharedPV::fetch"], [15, 1, 1, "_CPPv4NK4pvxs6server8SharedPV5fetchEv", "pvxs::server::SharedPV::fetch"], [15, 2, 1, "_CPPv4NK4pvxs6server8SharedPV5fetchER5Value", "pvxs::server::SharedPV::fetch::val"], [15, 1, 1, "_CPPv4NK4pvxs6server8SharedPV6isOpenEv", "pvxs::server::SharedPV::isOpen"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV14onFirstConnectERRNSt8functionIFvR8SharedPVEEE", "pvxs::server::SharedPV::onFirstConnect"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV14onFirstConnectERRNSt8functionIFvR8SharedPVEEE", "pvxs::server::SharedPV::onFirstConnect::fn"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV16onLastDisconnectERRNSt8functionIFvR8SharedPVEEE", "pvxs::server::SharedPV::onLastDisconnect"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV16onLastDisconnectERRNSt8functionIFvR8SharedPVEEE", "pvxs::server::SharedPV::onLastDisconnect::fn"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV5onPutERRNSt8functionIFvR8SharedPVRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::SharedPV::onPut"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV5onPutERRNSt8functionIFvR8SharedPVRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::SharedPV::onPut::fn"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV5onRPCERRNSt8functionIFvR8SharedPVRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::SharedPV::onRPC"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV5onRPCERRNSt8functionIFvR8SharedPVRRNSt10unique_ptrI6ExecOpEERR5ValueEEE", "pvxs::server::SharedPV::onRPC::fn"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV4openERK5Value", "pvxs::server::SharedPV::open"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV4openERK5Value", "pvxs::server::SharedPV::open::initial"], [15, 1, 1, "_CPPv4N4pvxs6server8SharedPV4postERK5Value", "pvxs::server::SharedPV::post"], [15, 2, 1, "_CPPv4N4pvxs6server8SharedPV4postERK5Value", "pvxs::server::SharedPV::post::val"], [16, 5, 1, "_CPPv4N4pvxs6server6SourceE", "pvxs::server::Source"], [16, 5, 1, "_CPPv4N4pvxs6server6Source4ListE", "pvxs::server::Source::List"], [16, 8, 1, "_CPPv4N4pvxs6server6Source4List7dynamicE", "pvxs::server::Source::List::dynamic"], [16, 8, 1, "_CPPv4N4pvxs6server6Source4List5namesE", "pvxs::server::Source::List::names"], [16, 5, 1, "_CPPv4N4pvxs6server6Source6SearchE", "pvxs::server::Source::Search"], [16, 5, 1, "_CPPv4N4pvxs6server6Source6Search4NameE", "pvxs::server::Source::Search::Name"], [16, 1, 1, "_CPPv4N4pvxs6server6Source6Search4Name5claimEv", "pvxs::server::Source::Search::Name::claim"], [16, 1, 1, "_CPPv4NK4pvxs6server6Source6Search4Name4nameEv", "pvxs::server::Source::Search::Name::name"], [16, 1, 1, "_CPPv4N4pvxs6server6Source6Search5beginEv", "pvxs::server::Source::Search::begin"], [16, 1, 1, "_CPPv4N4pvxs6server6Source6Search3endEv", "pvxs::server::Source::Search::end"], [16, 1, 1, "_CPPv4NK4pvxs6server6Source6Search4sizeEv", "pvxs::server::Source::Search::size"], [16, 1, 1, "_CPPv4NK4pvxs6server6Source6Search6sourceEv", "pvxs::server::Source::Search::source"], [16, 1, 1, "_CPPv4N4pvxs6server6Source8onCreateERRNSt10unique_ptrI14ChannelControlEE", "pvxs::server::Source::onCreate"], [16, 2, 1, "_CPPv4N4pvxs6server6Source8onCreateERRNSt10unique_ptrI14ChannelControlEE", "pvxs::server::Source::onCreate::op"], [16, 1, 1, "_CPPv4N4pvxs6server6Source6onListEv", "pvxs::server::Source::onList"], [16, 1, 1, "_CPPv4N4pvxs6server6Source8onSearchER6Search", "pvxs::server::Source::onSearch"], [16, 2, 1, "_CPPv4N4pvxs6server6Source8onSearchER6Search", "pvxs::server::Source::onSearch::op"], [16, 1, 1, "_CPPv4N4pvxs6server6Source4showERNSt7ostreamE", "pvxs::server::Source::show"], [16, 2, 1, "_CPPv4N4pvxs6server6Source4showERNSt7ostreamE", "pvxs::server::Source::show::strm"], [15, 5, 1, "_CPPv4N4pvxs6server12StaticSourceE", "pvxs::server::StaticSource"], [15, 1, 1, "_CPPv4N4pvxs6server12StaticSource3addERKNSt6stringERK8SharedPV", "pvxs::server::StaticSource::add"], [15, 2, 1, "_CPPv4N4pvxs6server12StaticSource3addERKNSt6stringERK8SharedPV", "pvxs::server::StaticSource::add::name"], [15, 2, 1, "_CPPv4N4pvxs6server12StaticSource3addERKNSt6stringERK8SharedPV", "pvxs::server::StaticSource::add::pv"], [15, 1, 1, "_CPPv4N4pvxs6server12StaticSource5closeEv", "pvxs::server::StaticSource::close"], [15, 1, 1, "_CPPv4N4pvxs6server12StaticSource6removeERKNSt6stringE", "pvxs::server::StaticSource::remove"], [15, 2, 1, "_CPPv4N4pvxs6server12StaticSource6removeERKNSt6stringE", "pvxs::server::StaticSource::remove::name"], [15, 1, 1, "_CPPv4NK4pvxs6server12StaticSource6sourceEv", "pvxs::server::StaticSource::source"], [19, 5, 1, "_CPPv4I00EN4pvxs12shared_arrayE", "pvxs::shared_array"], [19, 6, 1, "_CPPv4I00EN4pvxs12shared_arrayE", "pvxs::shared_array::E"], [19, 6, 1, "_CPPv4I00EN4pvxs12shared_arrayE", "pvxs::shared_array::Enable"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array2atE6size_t", "pvxs::shared_array::at"], [19, 2, 1, "_CPPv4NK4pvxs12shared_array2atE6size_t", "pvxs::shared_array::at::i"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array5beginEv", "pvxs::shared_array::begin"], [19, 1, 1, "_CPPv4I0ENK4pvxs12shared_array6castToE12shared_arrayI2TOEv", "pvxs::shared_array::castTo"], [19, 6, 1, "_CPPv4I0ENK4pvxs12shared_array6castToE12shared_arrayI2TOEv", "pvxs::shared_array::castTo::TO"], [19, 1, 1, "_CPPv4N4pvxs12shared_array5clearEv", "pvxs::shared_array::clear"], [19, 1, 1, "_CPPv4I0ENK4pvxs12shared_array9convertToE12shared_arrayI2TOEv", "pvxs::shared_array::convertTo"], [19, 6, 1, "_CPPv4I0ENK4pvxs12shared_array9convertToE12shared_arrayI2TOEv", "pvxs::shared_array::convertTo::TO"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array4dataEv", "pvxs::shared_array::data"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array5emptyEv", "pvxs::shared_array::empty"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array3endEv", "pvxs::shared_array::end"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array6formatEv", "pvxs::shared_array::format"], [19, 1, 1, "_CPPv4N4pvxs12shared_array6freezeEv", "pvxs::shared_array::freeze"], [19, 1, 1, "_CPPv4N4pvxs12shared_array11make_uniqueEv", "pvxs::shared_array::make_unique"], [19, 1, 1, "_CPPv4NK4pvxs12shared_arrayixE6size_t", "pvxs::shared_array::operator[]"], [19, 2, 1, "_CPPv4NK4pvxs12shared_arrayixE6size_t", "pvxs::shared_array::operator[]::i"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array13original_typeEv", "pvxs::shared_array::original_type"], [19, 1, 1, "_CPPv4N4pvxs12shared_array6resizeE6size_t", "pvxs::shared_array::resize"], [19, 2, 1, "_CPPv4N4pvxs12shared_array6resizeE6size_t", "pvxs::shared_array::resize::i"], [19, 1, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayE6size_t1V", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayENSt16initializer_listI1AEE", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayEP1E1B6size_t", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1AEEP1E6size_t", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4I0_NSt15iterator_traitsI4IterE15difference_typeEEN4pvxs12shared_array12shared_arrayE4Iter4Iter", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4N4pvxs12shared_array12shared_arrayE6size_t", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4N4pvxs12shared_array12shared_arrayEP1E6size_t", "pvxs::shared_array::shared_array"], [19, 1, 1, "_CPPv4N4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1EEE6size_t", "pvxs::shared_array::shared_array"], [19, 6, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayENSt16initializer_listI1AEE", "pvxs::shared_array::shared_array::A"], [19, 6, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1AEEP1E6size_t", "pvxs::shared_array::shared_array::A"], [19, 6, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayEP1E1B6size_t", "pvxs::shared_array::shared_array::B"], [19, 6, 1, "_CPPv4I0_NSt15iterator_traitsI4IterE15difference_typeEEN4pvxs12shared_array12shared_arrayE4Iter4Iter", "pvxs::shared_array::shared_array::Iter"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayENSt16initializer_listI1AEE", "pvxs::shared_array::shared_array::L"], [19, 6, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayE6size_t1V", "pvxs::shared_array::shared_array::V"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayEP1E1B6size_t", "pvxs::shared_array::shared_array::a"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1AEEP1E6size_t", "pvxs::shared_array::shared_array::a"], [19, 2, 1, "_CPPv4N4pvxs12shared_array12shared_arrayEP1E6size_t", "pvxs::shared_array::shared_array::a"], [19, 2, 1, "_CPPv4N4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1EEE6size_t", "pvxs::shared_array::shared_array::a"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayEP1E1B6size_t", "pvxs::shared_array::shared_array::b"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1AEEP1E6size_t", "pvxs::shared_array::shared_array::b"], [19, 2, 1, "_CPPv4I0_NSt15iterator_traitsI4IterE15difference_typeEEN4pvxs12shared_array12shared_arrayE4Iter4Iter", "pvxs::shared_array::shared_array::begin"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayE6size_t1V", "pvxs::shared_array::shared_array::c"], [19, 2, 1, "_CPPv4N4pvxs12shared_array12shared_arrayE6size_t", "pvxs::shared_array::shared_array::c"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayE6size_t1V", "pvxs::shared_array::shared_array::e"], [19, 2, 1, "_CPPv4I0_NSt15iterator_traitsI4IterE15difference_typeEEN4pvxs12shared_array12shared_arrayE4Iter4Iter", "pvxs::shared_array::shared_array::end"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayEP1E1B6size_t", "pvxs::shared_array::shared_array::len"], [19, 2, 1, "_CPPv4I0EN4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1AEEP1E6size_t", "pvxs::shared_array::shared_array::len"], [19, 2, 1, "_CPPv4N4pvxs12shared_array12shared_arrayEP1E6size_t", "pvxs::shared_array::shared_array::len"], [19, 2, 1, "_CPPv4N4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1EEE6size_t", "pvxs::shared_array::shared_array::len"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array4sizeEv", "pvxs::shared_array::size"], [19, 1, 1, "_CPPv4N4pvxs12shared_array4swapER12shared_array", "pvxs::shared_array::swap"], [19, 2, 1, "_CPPv4N4pvxs12shared_array4swapER12shared_array", "pvxs::shared_array::swap::o"], [19, 1, 1, "_CPPv4N4pvxs12shared_array4thawEv", "pvxs::shared_array::thaw"], [19, 1, 1, "_CPPv4NK4pvxs12shared_array6uniqueEv", "pvxs::shared_array::unique"], [18, 1, 1, "_CPPv4N4pvxs18target_informationERNSt7ostreamE", "pvxs::target_information"], [18, 5, 1, "_CPPv4N4pvxs8testCaseE", "pvxs::testCase"], [18, 1, 1, "_CPPv4NK4pvxs8testCasecvbEv", "pvxs::testCase::operator bool"], [18, 1, 1, "_CPPv4I0EN4pvxs8testCaselsER8testCaseRK1T", "pvxs::testCase::operator<<"], [18, 6, 1, "_CPPv4I0EN4pvxs8testCaselsER8testCaseRK1T", "pvxs::testCase::operator<<::T"], [18, 2, 1, "_CPPv4I0EN4pvxs8testCaselsER8testCaseRK1T", "pvxs::testCase::operator<<::v"], [18, 1, 1, "_CPPv4N4pvxs8testCase7setPassEb", "pvxs::testCase::setPass"], [18, 2, 1, "_CPPv4N4pvxs8testCase7setPassEb", "pvxs::testCase::setPass::v"], [18, 1, 1, "_CPPv4N4pvxs8testCase12setPassMatchERKNSt6stringERKNSt6stringE", "pvxs::testCase::setPassMatch"], [18, 2, 1, "_CPPv4N4pvxs8testCase12setPassMatchERKNSt6stringERKNSt6stringE", "pvxs::testCase::setPassMatch::expr"], [18, 2, 1, "_CPPv4N4pvxs8testCase12setPassMatchERKNSt6stringERKNSt6stringE", "pvxs::testCase::setPassMatch::inp"], [18, 1, 1, "_CPPv4N4pvxs8testCase6streamEv", "pvxs::testCase::stream"], [18, 1, 1, "_CPPv4N4pvxs8testCase8testCaseEb", "pvxs::testCase::testCase"], [18, 1, 1, "_CPPv4N4pvxs8testCase8testCaseEv", "pvxs::testCase::testCase"], [18, 2, 1, "_CPPv4N4pvxs8testCase8testCaseEb", "pvxs::testCase::testCase::result"], [18, 1, 1, "_CPPv4I00EN4pvxs10testThrowsE8testCase2FN", "pvxs::testThrows"], [18, 6, 1, "_CPPv4I00EN4pvxs10testThrowsE8testCase2FN", "pvxs::testThrows::Exception"], [18, 6, 1, "_CPPv4I00EN4pvxs10testThrowsE8testCase2FN", "pvxs::testThrows::FN"], [18, 2, 1, "_CPPv4I00EN4pvxs10testThrowsE8testCase2FN", "pvxs::testThrows::fn"], [18, 1, 1, "_CPPv4I00EN4pvxs15testThrowsMatchE8testCaseRKNSt6stringE2FN", "pvxs::testThrowsMatch"], [18, 6, 1, "_CPPv4I00EN4pvxs15testThrowsMatchE8testCaseRKNSt6stringE2FN", "pvxs::testThrowsMatch::Exception"], [18, 6, 1, "_CPPv4I00EN4pvxs15testThrowsMatchE8testCaseRKNSt6stringE2FN", "pvxs::testThrowsMatch::FN"], [18, 2, 1, "_CPPv4I00EN4pvxs15testThrowsMatchE8testCaseRKNSt6stringE2FN", "pvxs::testThrowsMatch::expr"], [18, 2, 1, "_CPPv4I00EN4pvxs15testThrowsMatchE8testCaseRKNSt6stringE2FN", "pvxs::testThrowsMatch::fn"], [18, 1, 1, "_CPPv4N4pvxs17version_abi_checkEv", "pvxs::version_abi_check"], [18, 1, 1, "_CPPv4N4pvxs15version_abi_intEv", "pvxs::version_abi_int"], [18, 1, 1, "_CPPv4N4pvxs11version_intEv", "pvxs::version_int"], [18, 1, 1, "_CPPv4N4pvxs11version_strEv", "pvxs::version_str"], [6, 1, 1, "_CPPv45pvxsiv", "pvxsi"], [6, 1, 1, "_CPPv45pvxsli", "pvxsl"], [6, 2, 1, "_CPPv45pvxsli", "pvxsl::level"], [6, 1, 1, "_CPPv45pvxsri", "pvxsr"], [6, 2, 1, "_CPPv45pvxsri", "pvxsr::level"]]}, "objtypes": {"0": "c:macro", "1": "cpp:function", "2": "cpp:functionParam", "3": "cpp:enum", "4": "cpp:enumerator", "5": "cpp:class", "6": "cpp:templateParam", "7": "cpp:type", "8": "cpp:member"}, "objnames": {"0": ["c", "macro", "C macro"], "1": ["cpp", "function", "C++ function"], "2": ["cpp", "functionParam", "C++ function parameter"], "3": ["cpp", "enum", "C++ enum"], "4": ["cpp", "enumerator", "C++ enumerator"], "5": ["cpp", "class", "C++ class"], "6": ["cpp", "templateParam", "C++ template parameter"], "7": ["cpp", "type", "C++ type"], "8": ["cpp", "member", "C++ member"]}, "titleterms": {"build": 0, "from": [0, 18], "sourc": [0, 16], "run": 0, "test": [0, 10, 18], "cross": 0, "compil": 0, "libevent2": 0, "includ": 0, "pvx": [0, 5, 10], "your": 0, "applic": [0, 18], "command": 1, "line": 1, "tool": 1, "troubleshoot": 1, "virtual": 1, "cabl": 1, "tester": 1, "client": [2, 4, 5], "api": [2, 3, 9, 14, 16, 19], "configur": [2, 7, 14], "make": 2, "request": 2, "get": [2, 4], "info": 2, "put": 2, "rpc": 2, "oper": 2, "result": 2, "monitor": 2, "connect": 2, "thread": [2, 16], "ownership": [2, 16], "pvrequest": 2, "syntax": 2, "misc": [2, 18], "detail": 3, "report": 3, "bug": 3, "packet": 3, "captur": 3, "releas": [3, 13], "polici": 3, "expert": 3, "contribut": 3, "contributor": 3, "implement": 3, "note": [3, 13], "exampl": [4, 12], "shortest": 4, "server": [4, 5, 6, 14], "demo": 4, "mailbox": 4, "pva": [5, 7, 11], "protocol": 5, "download": 5, "content": [5, 6, 8, 14, 19], "indic": 5, "tabl": 5, "ioc": [6, 18], "integr": 6, "shell": 6, "ad": 6, "custom": [6, 10, 17], "pv": [6, 10], "qsrv": [6, 12], "2": [6, 13], "singl": 6, "group": [6, 12], "access": 6, "secur": 6, "pvaccess": [6, 10], "link": [6, 11], "network": 7, "big": 7, "pictur": 7, "environ": 7, "variabl": 7, "address": 7, "spec": 7, "common": 8, "type": [8, 17], "definit": 8, "forward": [8, 11], "compat": 8, "time_t": 8, "alarm_t": 8, "ntenum": 8, "ntndarrai": 8, "nttabl": [8, 12], "nturi": 8, "ntscalar": [9, 10], "ntscalararrai": 9, "field": [9, 10, 19], "builder": 9, "overview": 10, "basic": 10, "what": 10, "i": 10, "epic": 10, "modul": 10, "comparison": 10, "pvdatacpp": 10, "sub": 10, "lookup": [10, 19], "structur": 10, "iter": [10, 19], "chang": 10, "track": 10, "pvaccesscpp": 10, "json": [11, 12], "refer": [11, 12], "input": 11, "output": 11, "understand": 12, "databas": 12, "list": 12, "1": 13, "3": 13, "unreleas": 13, "dec": 13, "2023": 13, "0": 13, "4": 13, "oct": 13, "sept": 13, "june": 13, "mai": 13, "april": 13, "mar": 13, "feb": 13, "2022": 13, "nov": 13, "jan": 13, "2021": 13, "juli": 13, "5": 13, "apr": 13, "2020": 13, "sharedpv": 15, "staticsourc": 15, "data": 16, "lifetim": 16, "defin": 17, "log": 18, "control": 18, "user": 18, "identif": 18, "unit": 18, "helper": 18, "util": 18, "valu": 19, "contain": 19, "arrai": 19}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Examples": [[4, "examples"]], "Shortest Client Get": [[4, "shortest-client-get"]], "Shortest Server": [[4, "shortest-server"]], "Client Demo": [[4, "client-demo"]], "Mailbox Server": [[4, "mailbox-server"]], "Building from Source": [[0, "building-from-source"]], "Running Tests": [[0, "running-tests"]], "Cross-compiling libevent2": [[0, "cross-compiling-libevent2"]], "Including PVXS in your application": [[0, "including-pvxs-in-your-application"]], "Command Line Tools": [[1, "command-line-tools"]], "Troubleshooting with Virtual Cable Tester": [[1, "troubleshooting-with-virtual-cable-tester"]], "PVXS client/server for PVA Protocol": [[5, "pvxs-client-server-for-pva-protocol"]], "Download": [[5, "download"]], "Contents:": [[5, null], [6, null], [6, null], [14, null], [8, null], [19, null]], "Indices and tables": [[5, "indices-and-tables"]], "PVA Network Configuration": [[7, "pva-network-configuration"]], "Big Picture": [[7, "big-picture"]], "Environment variables": [[7, "environment-variables"]], "Address Spec.": [[7, "address-spec"]], "Details": [[3, "details"]], "Reporting a Bug": [[3, "reporting-a-bug"]], "Packet Capture": [[3, "packet-capture"]], "Release Policy": [[3, "release-policy"]], "Expert APIs": [[3, "expert-apis"]], "Contributing": [[3, "contributing"]], "Contributors": [[3, "contributors"]], "Implementation Notes": [[3, "implementation-notes"]], "PVA Links": [[11, "pva-links"]], "JSON Reference": [[11, "json-reference"], [12, "json-reference"]], "Input Links": [[11, "input-links"]], "Output Links": [[11, "output-links"]], "Forward Links": [[11, "forward-links"]], "Overview": [[10, "overview"]], "Basics": [[10, "basics"]], "What is EPICS?": [[10, "what-is-epics"]], "What is PVAccess?": [[10, "what-is-pvaccess"]], "What is a PV?": [[10, "what-is-a-pv"]], "PVXS Module": [[10, "pvxs-module"]], "Comparison with pvDataCPP": [[10, "comparison-with-pvdatacpp"]], "Sub-field Lookup": [[10, "sub-field-lookup"]], "Structure Iteration": [[10, "structure-iteration"]], "Testing for changed fields": [[10, "testing-for-changed-fields"]], "Tracking changed fields": [[10, "tracking-changed-fields"]], "NTScalar": [[10, "ntscalar"]], "Custom Structures": [[10, "custom-structures"]], "Comparison with pvAccessCPP": [[10, "comparison-with-pvaccesscpp"]], "QSRV Groups": [[12, "qsrv-groups"]], "Understanding Groups": [[12, "understanding-groups"]], "NTTable Group Example": [[12, "nttable-group-example"]], "Database Listing": [[12, "database-listing"]], "Release Notes": [[13, "release-notes"]], "1.3.2 (UNRELEASED)": [[13, "unreleased"]], "1.3.1 (Dec 2023)": [[13, "dec-2023"]], "1.3.0 (Dec 2023)": [[13, "id1"]], "1.2.4 (Oct 2023)": [[13, "oct-2023"]], "1.2.3 (Sept 2023)": [[13, "sept-2023"]], "1.2.2 (June 2023)": [[13, "june-2023"]], "1.2.1 (June 2023)": [[13, "id2"]], "1.2.0 (May 2023)": [[13, "may-2023"]], "1.1.4 (April 2023)": [[13, "april-2023"]], "1.1.3 (Mar 2023)": [[13, "mar-2023"]], "1.1.2 (Feb 2023)": [[13, "feb-2023"]], "1.1.1 (Dec 2022)": [[13, "dec-2022"]], "1.1.0 (Nov 2022)": [[13, "nov-2022"]], "1.0.1 (Oct 2022)": [[13, "oct-2022"]], "1.0.0 (Sept 2022)": [[13, "sept-2022"]], "0.3.1 (June 2022)": [[13, "june-2022"]], "0.3.0 (May 2022)": [[13, "may-2022"]], "0.2.2 (Jan 2022)": [[13, "jan-2022"]], "0.2.1 (Oct 2021)": [[13, "oct-2021"]], "0.2.0 (July 2021)": [[13, "july-2021"]], "0.1.5 (May 2021)": [[13, "may-2021"]], "0.1.4 (APR 2021)": [[13, "apr-2021"]], "0.1.3 (FEB 2021)": [[13, "feb-2021"]], "0.1.2 (FEB 2021)": [[13, "id3"]], "0.1.1 (Jan 2021)": [[13, "jan-2021"]], "0.1.0 (Dec 2020)": [[13, "dec-2020"]], "NTScalar and NTScalarArray": [[9, "ntscalar-and-ntscalararray"]], "Fields": [[9, "fields"]], "Builder API": [[9, "builder-api"]], "SharedPV and StaticSource": [[15, "sharedpv-and-staticsource"]], "IOC Integration": [[6, "ioc-integration"]], "IOC shell": [[6, "ioc-shell"]], "Adding custom PVs to Server": [[6, "adding-custom-pvs-to-server"]], "QSRV 2": [[6, "qsrv-2"]], "IOC Shell": [[6, "id1"]], "Single PV": [[6, "single-pv"]], "Group PV": [[6, "group-pv"]], "Access Security": [[6, "access-security"]], "PVAccess Links": [[6, "pvaccess-links"]], "Data Source": [[16, "data-source"]], "Threading": [[16, "threading"], [2, "threading"]], "Ownership and Lifetime": [[16, "ownership-and-lifetime"]], "API": [[16, "api"]], "Server API": [[14, "server-api"]], "Configuration": [[14, "configuration"], [2, "configuration"]], "Common Type Definitions": [[8, "common-type-definitions"]], "Forward Compatibility": [[8, "forward-compatibility"]], "time_t": [[8, "time-t"]], "alarm_t": [[8, "alarm-t"]], "NTEnum": [[8, "ntenum"]], "NTNDArray": [[8, "ntndarray"]], "NTTable": [[8, "nttable"]], "NTURI": [[8, "nturi"]], "Defining Custom Types": [[17, "defining-custom-types"]], "Value Container API": [[19, "value-container-api"]], "Value": [[19, "value"]], "Field Lookup": [[19, "field-lookup"]], "Iteration": [[19, "iteration"]], "Array fields": [[19, "array-fields"]], "Misc": [[18, "misc"], [2, "misc"]], "Logging": [[18, "logging"]], "Controlling Logging": [[18, "controlling-logging"]], "Logging from User applications": [[18, "logging-from-user-applications"]], "Identification": [[18, "identification"]], "Unit-test helpers": [[18, "unit-test-helpers"]], "IOC Testing": [[18, "ioc-testing"]], "Utilities": [[18, "utilities"]], "Client API": [[2, "client-api"]], "Making Requests": [[2, "making-requests"]], "Get/Info": [[2, "get-info"]], "Put": [[2, "put"]], "RPC": [[2, "rpc"]], "Operation and Result": [[2, "operation-and-result"]], "Monitor": [[2, "monitor"]], "Connect": [[2, "connect"]], "Ownership": [[2, "ownership"]], "pvRequest": [[2, "pvrequest"]], "Syntax": [[2, "syntax"]]}, "indexentries": {"pvxs::client::config (c++ struct)": [[2, "_CPPv4N4pvxs6client6ConfigE"]], "pvxs::client::config::addresslist (c++ member)": [[2, "_CPPv4N4pvxs6client6Config11addressListE"]], "pvxs::client::config::applydefs (c++ function)": [[2, "_CPPv4N4pvxs6client6Config9applyDefsERK6defs_t"]], "pvxs::client::config::applyenv (c++ function)": [[2, "_CPPv4N4pvxs6client6Config8applyEnvEv"]], "pvxs::client::config::autoaddrlist (c++ member)": [[2, "_CPPv4N4pvxs6client6Config12autoAddrListE"]], "pvxs::client::config::build (c++ function)": [[2, "_CPPv4NK4pvxs6client6Config5buildEv"]], "pvxs::client::config::expand (c++ function)": [[2, "_CPPv4N4pvxs6client6Config6expandEv"]], "pvxs::client::config::fromenv (c++ function)": [[2, "_CPPv4N4pvxs6client6Config7fromEnvEv"]], "pvxs::client::config::interfaces (c++ member)": [[2, "_CPPv4N4pvxs6client6Config10interfacesE"]], "pvxs::client::config::nameservers (c++ member)": [[2, "_CPPv4N4pvxs6client6Config11nameServersE"]], "pvxs::client::config::tcptimeout (c++ member)": [[2, "_CPPv4N4pvxs6client6Config10tcpTimeoutE"]], "pvxs::client::config::tcp_port (c++ member)": [[2, "_CPPv4N4pvxs6client6Config8tcp_portE"]], "pvxs::client::config::udp_port (c++ member)": [[2, "_CPPv4N4pvxs6client6Config8udp_portE"]], "pvxs::client::config::updatedefs (c++ function)": [[2, "_CPPv4NK4pvxs6client6Config10updateDefsER6defs_t"]], "pvxs::client::connect (c++ struct)": [[2, "_CPPv4N4pvxs6client7ConnectE"]], "pvxs::client::connect::connected (c++ function)": [[2, "_CPPv4NK4pvxs6client7Connect9connectedEv"]], "pvxs::client::connect::name (c++ function)": [[2, "_CPPv4NK4pvxs6client7Connect4nameEv"]], "pvxs::client::connectbuilder (c++ class)": [[2, "_CPPv4N4pvxs6client14ConnectBuilderE"]], "pvxs::client::connectbuilder::exec (c++ function)": [[2, "_CPPv4N4pvxs6client14ConnectBuilder4execEv"]], "pvxs::client::connectbuilder::onconnect (c++ function)": [[2, "_CPPv4N4pvxs6client14ConnectBuilder9onConnectERRNSt8functionIFvvEEE"]], "pvxs::client::connectbuilder::ondisconnect (c++ function)": [[2, "_CPPv4N4pvxs6client14ConnectBuilder12onDisconnectERRNSt8functionIFvvEEE"]], "pvxs::client::connectbuilder::synccancel (c++ function)": [[2, "_CPPv4N4pvxs6client14ConnectBuilder10syncCancelEb"]], "pvxs::client::connected (c++ struct)": [[2, "_CPPv4N4pvxs6client9ConnectedE"]], "pvxs::client::context (c++ class)": [[2, "_CPPv4N4pvxs6client7ContextE"]], "pvxs::client::context::context (c++ function)": [[2, "_CPPv4N4pvxs6client7Context7ContextERK6Config"], [2, "_CPPv4N4pvxs6client7Context7ContextEv"]], "pvxs::client::context::close (c++ function)": [[2, "_CPPv4N4pvxs6client7Context5closeEv"]], "pvxs::client::context::config (c++ function)": [[2, "_CPPv4NK4pvxs6client7Context6configEv"]], "pvxs::client::context::connect (c++ function)": [[2, "_CPPv4N4pvxs6client7Context7connectERKNSt6stringE"]], "pvxs::client::context::discover (c++ function)": [[2, "_CPPv4N4pvxs6client7Context8discoverERRNSt8functionIFvRK10DiscoveredEEE"]], "pvxs::client::context::fromenv (c++ function)": [[2, "_CPPv4N4pvxs6client7Context7fromEnvEv"]], "pvxs::client::context::get (c++ function)": [[2, "_CPPv4N4pvxs6client7Context3getERKNSt6stringE"]], "pvxs::client::context::hurryup (c++ function)": [[2, "_CPPv4N4pvxs6client7Context7hurryUpEv"]], "pvxs::client::context::info (c++ function)": [[2, "_CPPv4N4pvxs6client7Context4infoERKNSt6stringE"]], "pvxs::client::context::monitor (c++ function)": [[2, "_CPPv4N4pvxs6client7Context7monitorERKNSt6stringE"]], "pvxs::client::context::put (c++ function)": [[2, "_CPPv4N4pvxs6client7Context3putERKNSt6stringE"]], "pvxs::client::context::request (c++ function)": [[2, "_CPPv4N4pvxs6client7Context7requestEv"]], "pvxs::client::context::rpc (c++ function)": [[2, "_CPPv4N4pvxs6client7Context3rpcERKNSt6stringERK5Value"]], "pvxs::client::disconnect (c++ struct)": [[2, "_CPPv4N4pvxs6client10DisconnectE"]], "pvxs::client::disconnect::time (c++ member)": [[2, "_CPPv4N4pvxs6client10Disconnect4timeE"]], "pvxs::client::finished (c++ struct)": [[2, "_CPPv4N4pvxs6client8FinishedE"]], "pvxs::client::getbuilder (c++ class)": [[2, "_CPPv4N4pvxs6client10GetBuilderE"]], "pvxs::client::getbuilder::exec (c++ function)": [[2, "_CPPv4N4pvxs6client10GetBuilder4execEv"]], "pvxs::client::getbuilder::result (c++ function)": [[2, "_CPPv4N4pvxs6client10GetBuilder6resultERRNSt8functionIFvRR6ResultEEE"]], "pvxs::client::monitorbuilder (c++ class)": [[2, "_CPPv4N4pvxs6client14MonitorBuilderE"]], "pvxs::client::monitorbuilder::event (c++ function)": [[2, "_CPPv4N4pvxs6client14MonitorBuilder5eventERRNSt8functionIFvR12SubscriptionEEE"]], "pvxs::client::monitorbuilder::exec (c++ function)": [[2, "_CPPv4N4pvxs6client14MonitorBuilder4execEv"]], "pvxs::client::monitorbuilder::maskconnected (c++ function)": [[2, "_CPPv4N4pvxs6client14MonitorBuilder13maskConnectedEb"]], "pvxs::client::monitorbuilder::maskdisconnected (c++ function)": [[2, "_CPPv4N4pvxs6client14MonitorBuilder16maskDisconnectedEb"]], "pvxs::client::operation (c++ struct)": [[2, "_CPPv4N4pvxs6client9OperationE"]], "pvxs::client::operation::cancel (c++ function)": [[2, "_CPPv4N4pvxs6client9Operation6cancelEv"]], "pvxs::client::operation::interrupt (c++ function)": [[2, "_CPPv4N4pvxs6client9Operation9interruptEv"]], "pvxs::client::operation::name (c++ function)": [[2, "_CPPv4N4pvxs6client9Operation4nameEv"]], "pvxs::client::operation::operation_t (c++ enum)": [[2, "_CPPv4N4pvxs6client9Operation11operation_tE"]], "pvxs::client::operation::operation_t::discover (c++ enumerator)": [[2, "_CPPv4N4pvxs6client9Operation11operation_t8DiscoverE"]], "pvxs::client::operation::operation_t::get (c++ enumerator)": [[2, "_CPPv4N4pvxs6client9Operation11operation_t3GetE"]], "pvxs::client::operation::operation_t::info (c++ enumerator)": [[2, "_CPPv4N4pvxs6client9Operation11operation_t4InfoE"]], "pvxs::client::operation::operation_t::monitor (c++ enumerator)": [[2, "_CPPv4N4pvxs6client9Operation11operation_t7MonitorE"]], "pvxs::client::operation::operation_t::put (c++ enumerator)": [[2, "_CPPv4N4pvxs6client9Operation11operation_t3PutE"]], "pvxs::client::operation::operation_t::rpc (c++ enumerator)": [[2, "_CPPv4N4pvxs6client9Operation11operation_t3RPCE"]], "pvxs::client::operation::wait (c++ function)": [[2, "_CPPv4N4pvxs6client9Operation4waitEd"], [2, "_CPPv4N4pvxs6client9Operation4waitEv"]], "pvxs::client::putbuilder (c++ class)": [[2, "_CPPv4N4pvxs6client10PutBuilderE"]], "pvxs::client::putbuilder::build (c++ function)": [[2, "_CPPv4N4pvxs6client10PutBuilder5buildERRNSt8functionIF5ValueRR5ValueEEE"]], "pvxs::client::putbuilder::exec (c++ function)": [[2, "_CPPv4N4pvxs6client10PutBuilder4execEv"]], "pvxs::client::putbuilder::fetchpresent (c++ function)": [[2, "_CPPv4N4pvxs6client10PutBuilder12fetchPresentEb"]], "pvxs::client::putbuilder::result (c++ function)": [[2, "_CPPv4N4pvxs6client10PutBuilder6resultERRNSt8functionIFvRR6ResultEEE"]], "pvxs::client::putbuilder::set (c++ function)": [[2, "_CPPv4I0EN4pvxs6client10PutBuilder3setER10PutBuilderRKNSt6stringERK1Tb"]], "pvxs::client::rpcbuilder (c++ class)": [[2, "_CPPv4N4pvxs6client10RPCBuilderE"]], "pvxs::client::rpcbuilder::arg (c++ function)": [[2, "_CPPv4I0EN4pvxs6client10RPCBuilder3argER10RPCBuilderRKNSt6stringERK1T"]], "pvxs::client::rpcbuilder::exec (c++ function)": [[2, "_CPPv4N4pvxs6client10RPCBuilder4execEv"]], "pvxs::client::rpcbuilder::result (c++ function)": [[2, "_CPPv4N4pvxs6client10RPCBuilder6resultERRNSt8functionIFvRR6ResultEEE"]], "pvxs::client::remoteerror (c++ struct)": [[2, "_CPPv4N4pvxs6client11RemoteErrorE"]], "pvxs::client::result (c++ class)": [[2, "_CPPv4N4pvxs6client6ResultE"]], "pvxs::client::result::operator() (c++ function)": [[2, "_CPPv4N4pvxs6client6ResultclEv"]], "pvxs::client::subscription (c++ struct)": [[2, "_CPPv4N4pvxs6client12SubscriptionE"]], "pvxs::client::subscription::cancel (c++ function)": [[2, "_CPPv4N4pvxs6client12Subscription6cancelEv"]], "pvxs::client::subscription::name (c++ function)": [[2, "_CPPv4N4pvxs6client12Subscription4nameEv"]], "pvxs::client::subscription::pause (c++ function)": [[2, "_CPPv4N4pvxs6client12Subscription5pauseEb"]], "pvxs::client::subscription::pop (c++ function)": [[2, "_CPPv4N4pvxs6client12Subscription3popEv"]], "pvxs::client::subscription::resume (c++ function)": [[2, "_CPPv4N4pvxs6client12Subscription6resumeEv"]], "pvxs::client::subscription::shared_from_this (c++ function)": [[2, "_CPPv4NK4pvxs6client12Subscription16shared_from_thisEv"]], "pvxs::client::subscription::stats (c++ function)": [[2, "_CPPv4N4pvxs6client12Subscription5statsER16SubscriptionStatb"]], "pvxs::client::detail::commonbuilder (c++ class)": [[2, "_CPPv4I00EN4pvxs6client6detail13CommonBuilderE"]], "pvxs::client::detail::commonbuilder::field (c++ function)": [[2, "_CPPv4N4pvxs6client6detail13CommonBuilder5fieldERKNSt6stringE"]], "pvxs::client::detail::commonbuilder::pvrequest (c++ function)": [[2, "_CPPv4N4pvxs6client6detail13CommonBuilder9pvRequestERKNSt6stringE"]], "pvxs::client::detail::commonbuilder::rawrequest (c++ function)": [[2, "_CPPv4N4pvxs6client6detail13CommonBuilder10rawRequestERK5Value"]], "pvxs::client::detail::commonbuilder::record (c++ function)": [[2, "_CPPv4I0EN4pvxs6client6detail13CommonBuilder6recordER10SubBuilderRKNSt6stringERK1T"]], "pvxs::client::detail::commonbuilder::synccancel (c++ function)": [[2, "_CPPv4N4pvxs6client6detail13CommonBuilder10syncCancelEb"]], "dbloadgroup (c++ function)": [[6, "_CPPv411dbLoadGroupPKcPKc"]], "pvxgl (c++ function)": [[6, "_CPPv45pvxgliPKc"]], "pvxs::ioc::server (c++ function)": [[6, "_CPPv4N4pvxs3ioc6serverEv"]], "pvxsi (c++ function)": [[6, "_CPPv45pvxsiv"]], "pvxsl (c++ function)": [[6, "_CPPv45pvxsli"]], "pvxsr (c++ function)": [[6, "_CPPv45pvxsri"]], "pvxs::nt::alarm (c++ struct)": [[8, "_CPPv4N4pvxs2nt5AlarmE"]], "pvxs::nt::ntenum (c++ struct)": [[8, "_CPPv4N4pvxs2nt6NTEnumE"]], "pvxs::nt::ntenum::build (c++ function)": [[8, "_CPPv4NK4pvxs2nt6NTEnum5buildEv"]], "pvxs::nt::ntenum::create (c++ function)": [[8, "_CPPv4NK4pvxs2nt6NTEnum6createEv"]], "pvxs::nt::ntndarray (c++ struct)": [[8, "_CPPv4N4pvxs2nt9NTNDArrayE"]], "pvxs::nt::ntndarray::build (c++ function)": [[8, "_CPPv4NK4pvxs2nt9NTNDArray5buildEv"]], "pvxs::nt::ntndarray::create (c++ function)": [[8, "_CPPv4NK4pvxs2nt9NTNDArray6createEv"]], "pvxs::nt::nttable (c++ struct)": [[8, "_CPPv4N4pvxs2nt7NTTableE"]], "pvxs::nt::nttable::add_column (c++ function)": [[8, "_CPPv4N4pvxs2nt7NTTable10add_columnE8TypeCodePKcPKc"]], "pvxs::nt::nttable::build (c++ function)": [[8, "_CPPv4NK4pvxs2nt7NTTable5buildEv"]], "pvxs::nt::nttable::create (c++ function)": [[8, "_CPPv4NK4pvxs2nt7NTTable6createEv"]], "pvxs::nt::nturi (c++ class)": [[8, "_CPPv4N4pvxs2nt5NTURIE"]], "pvxs::nt::nturi::build (c++ function)": [[8, "_CPPv4NK4pvxs2nt5NTURI5buildEv"]], "pvxs::nt::nturi::create (c++ function)": [[8, "_CPPv4NK4pvxs2nt5NTURI6createEv"]], "pvxs::nt::timestamp (c++ struct)": [[8, "_CPPv4N4pvxs2nt9TimeStampE"]], "pvxs::nt::ntscalar (c++ struct)": [[9, "_CPPv4N4pvxs2nt8NTScalarE"]], "pvxs::nt::ntscalar::build (c++ function)": [[9, "_CPPv4NK4pvxs2nt8NTScalar5buildEv"]], "pvxs::nt::ntscalar::control (c++ member)": [[9, "_CPPv4N4pvxs2nt8NTScalar7controlE"]], "pvxs::nt::ntscalar::create (c++ function)": [[9, "_CPPv4NK4pvxs2nt8NTScalar6createEv"]], "pvxs::nt::ntscalar::display (c++ member)": [[9, "_CPPv4N4pvxs2nt8NTScalar7displayE"]], "pvxs::nt::ntscalar::form (c++ member)": [[9, "_CPPv4N4pvxs2nt8NTScalar4formE"]], "pvxs::nt::ntscalar::value (c++ member)": [[9, "_CPPv4N4pvxs2nt8NTScalar5valueE"]], "pvxs::nt::ntscalar::valuealarm (c++ member)": [[9, "_CPPv4N4pvxs2nt8NTScalar10valueAlarmE"]], "pvxs::server::config (c++ struct)": [[14, "_CPPv4N4pvxs6server6ConfigE"]], "pvxs::server::config::applydefs (c++ function)": [[14, "_CPPv4N4pvxs6server6Config9applyDefsERK6defs_t"]], "pvxs::server::config::applyenv (c++ function)": [[14, "_CPPv4N4pvxs6server6Config8applyEnvEv"]], "pvxs::server::config::auto_beacon (c++ member)": [[14, "_CPPv4N4pvxs6server6Config11auto_beaconE"]], "pvxs::server::config::beacondestinations (c++ member)": [[14, "_CPPv4N4pvxs6server6Config18beaconDestinationsE"]], "pvxs::server::config::build (c++ function)": [[14, "_CPPv4NK4pvxs6server6Config5buildEv"]], "pvxs::server::config::expand (c++ function)": [[14, "_CPPv4N4pvxs6server6Config6expandEv"]], "pvxs::server::config::fromenv (c++ function)": [[14, "_CPPv4N4pvxs6server6Config7fromEnvEv"]], "pvxs::server::config::guid (c++ member)": [[14, "_CPPv4N4pvxs6server6Config4guidE"]], "pvxs::server::config::ignoreaddrs (c++ member)": [[14, "_CPPv4N4pvxs6server6Config11ignoreAddrsE"]], "pvxs::server::config::interfaces (c++ member)": [[14, "_CPPv4N4pvxs6server6Config10interfacesE"]], "pvxs::server::config::isolated (c++ function)": [[14, "_CPPv4N4pvxs6server6Config8isolatedEi"]], "pvxs::server::config::tcptimeout (c++ member)": [[14, "_CPPv4N4pvxs6server6Config10tcpTimeoutE"]], "pvxs::server::config::tcp_port (c++ member)": [[14, "_CPPv4N4pvxs6server6Config8tcp_portE"]], "pvxs::server::config::udp_port (c++ member)": [[14, "_CPPv4N4pvxs6server6Config8udp_portE"]], "pvxs::server::config::updatedefs (c++ function)": [[14, "_CPPv4NK4pvxs6server6Config10updateDefsER6defs_t"]], "pvxs::server::server (c++ class)": [[14, "_CPPv4N4pvxs6server6ServerE"]], "pvxs::server::server::server (c++ function)": [[14, "_CPPv4N4pvxs6server6Server6ServerERK6Config"], [14, "_CPPv4N4pvxs6server6Server6ServerEv"]], "pvxs::server::server::addpv (c++ function)": [[14, "_CPPv4N4pvxs6server6Server5addPVERKNSt6stringERK8SharedPV"]], "pvxs::server::server::addsource (c++ function)": [[14, "_CPPv4N4pvxs6server6Server9addSourceERKNSt6stringERKNSt10shared_ptrI6SourceEEi"]], "pvxs::server::server::clientconfig (c++ function)": [[14, "_CPPv4NK4pvxs6server6Server12clientConfigEv"]], "pvxs::server::server::config (c++ function)": [[14, "_CPPv4NK4pvxs6server6Server6configEv"]], "pvxs::server::server::fromenv (c++ function)": [[14, "_CPPv4N4pvxs6server6Server7fromEnvEv"]], "pvxs::server::server::getsource (c++ function)": [[14, "_CPPv4N4pvxs6server6Server9getSourceERKNSt6stringEi"]], "pvxs::server::server::interrupt (c++ function)": [[14, "_CPPv4N4pvxs6server6Server9interruptEv"]], "pvxs::server::server::listsource (c++ function)": [[14, "_CPPv4N4pvxs6server6Server10listSourceEv"]], "pvxs::server::server::removepv (c++ function)": [[14, "_CPPv4N4pvxs6server6Server8removePVERKNSt6stringE"]], "pvxs::server::server::removesource (c++ function)": [[14, "_CPPv4N4pvxs6server6Server12removeSourceERKNSt6stringEi"]], "pvxs::server::server::run (c++ function)": [[14, "_CPPv4N4pvxs6server6Server3runEv"]], "pvxs::server::server::start (c++ function)": [[14, "_CPPv4N4pvxs6server6Server5startEv"]], "pvxs::server::server::stop (c++ function)": [[14, "_CPPv4N4pvxs6server6Server4stopEv"]], "pvxs::server::sharedpv (c++ struct)": [[15, "_CPPv4N4pvxs6server8SharedPVE"]], "pvxs::server::sharedpv::attach (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV6attachERRNSt10unique_ptrI14ChannelControlEE"]], "pvxs::server::sharedpv::buildmailbox (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV12buildMailboxEv"]], "pvxs::server::sharedpv::buildreadonly (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV13buildReadonlyEv"]], "pvxs::server::sharedpv::close (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV5closeEv"]], "pvxs::server::sharedpv::fetch (c++ function)": [[15, "_CPPv4NK4pvxs6server8SharedPV5fetchER5Value"], [15, "_CPPv4NK4pvxs6server8SharedPV5fetchEv"]], "pvxs::server::sharedpv::isopen (c++ function)": [[15, "_CPPv4NK4pvxs6server8SharedPV6isOpenEv"]], "pvxs::server::sharedpv::onfirstconnect (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV14onFirstConnectERRNSt8functionIFvR8SharedPVEEE"]], "pvxs::server::sharedpv::onlastdisconnect (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV16onLastDisconnectERRNSt8functionIFvR8SharedPVEEE"]], "pvxs::server::sharedpv::onput (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV5onPutERRNSt8functionIFvR8SharedPVRRNSt10unique_ptrI6ExecOpEERR5ValueEEE"]], "pvxs::server::sharedpv::onrpc (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV5onRPCERRNSt8functionIFvR8SharedPVRRNSt10unique_ptrI6ExecOpEERR5ValueEEE"]], "pvxs::server::sharedpv::open (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV4openERK5Value"]], "pvxs::server::sharedpv::post (c++ function)": [[15, "_CPPv4N4pvxs6server8SharedPV4postERK5Value"]], "pvxs::server::staticsource (c++ struct)": [[15, "_CPPv4N4pvxs6server12StaticSourceE"]], "pvxs::server::staticsource::add (c++ function)": [[15, "_CPPv4N4pvxs6server12StaticSource3addERKNSt6stringERK8SharedPV"]], "pvxs::server::staticsource::close (c++ function)": [[15, "_CPPv4N4pvxs6server12StaticSource5closeEv"]], "pvxs::server::staticsource::remove (c++ function)": [[15, "_CPPv4N4pvxs6server12StaticSource6removeERKNSt6stringE"]], "pvxs::server::staticsource::source (c++ function)": [[15, "_CPPv4NK4pvxs6server12StaticSource6sourceEv"]], "pvxs::server::channelcontrol (c++ struct)": [[16, "_CPPv4N4pvxs6server14ChannelControlE"]], "pvxs::server::channelcontrol::close (c++ function)": [[16, "_CPPv4N4pvxs6server14ChannelControl5closeEv"]], "pvxs::server::channelcontrol::onclose (c++ function)": [[16, "_CPPv4N4pvxs6server14ChannelControl7onCloseERRNSt8functionIFvRKNSt6stringEEEE"]], "pvxs::server::channelcontrol::onop (c++ function)": [[16, "_CPPv4N4pvxs6server14ChannelControl4onOpERRNSt8functionIFvRRNSt10unique_ptrI9ConnectOpEEEEE"]], "pvxs::server::channelcontrol::onrpc (c++ function)": [[16, "_CPPv4N4pvxs6server14ChannelControl5onRPCERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEERR5ValueEEE"]], "pvxs::server::channelcontrol::onsubscribe (c++ function)": [[16, "_CPPv4N4pvxs6server14ChannelControl11onSubscribeERRNSt8functionIFvRRNSt10unique_ptrI14MonitorSetupOpEEEEE"]], "pvxs::server::clientcredentials (c++ struct)": [[16, "_CPPv4N4pvxs6server17ClientCredentialsE"]], "pvxs::server::clientcredentials::account (c++ member)": [[16, "_CPPv4N4pvxs6server17ClientCredentials7accountE"]], "pvxs::server::clientcredentials::iface (c++ member)": [[16, "_CPPv4N4pvxs6server17ClientCredentials5ifaceE"]], "pvxs::server::clientcredentials::method (c++ member)": [[16, "_CPPv4N4pvxs6server17ClientCredentials6methodE"]], "pvxs::server::clientcredentials::peer (c++ member)": [[16, "_CPPv4N4pvxs6server17ClientCredentials4peerE"]], "pvxs::server::clientcredentials::raw (c++ member)": [[16, "_CPPv4N4pvxs6server17ClientCredentials3rawE"]], "pvxs::server::clientcredentials::roles (c++ function)": [[16, "_CPPv4NK4pvxs6server17ClientCredentials5rolesEv"]], "pvxs::server::connectop (c++ struct)": [[16, "_CPPv4N4pvxs6server9ConnectOpE"]], "pvxs::server::connectop::connect (c++ function)": [[16, "_CPPv4N4pvxs6server9ConnectOp7connectERK5Value"]], "pvxs::server::connectop::error (c++ function)": [[16, "_CPPv4N4pvxs6server9ConnectOp5errorERKNSt6stringE"]], "pvxs::server::connectop::onclose (c++ function)": [[16, "_CPPv4N4pvxs6server9ConnectOp7onCloseERRNSt8functionIFvRKNSt6stringEEEE"]], "pvxs::server::connectop::onget (c++ function)": [[16, "_CPPv4N4pvxs6server9ConnectOp5onGetERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEEEEE"]], "pvxs::server::connectop::onput (c++ function)": [[16, "_CPPv4N4pvxs6server9ConnectOp5onPutERRNSt8functionIFvRRNSt10unique_ptrI6ExecOpEERR5ValueEEE"]], "pvxs::server::execop (c++ struct)": [[16, "_CPPv4N4pvxs6server6ExecOpE"]], "pvxs::server::execop::error (c++ function)": [[16, "_CPPv4N4pvxs6server6ExecOp5errorERKNSt6stringE"]], "pvxs::server::execop::oncancel (c++ function)": [[16, "_CPPv4N4pvxs6server6ExecOp8onCancelERRNSt8functionIFvvEEE"]], "pvxs::server::execop::pvrequest (c++ function)": [[16, "_CPPv4NK4pvxs6server6ExecOp9pvRequestEv"]], "pvxs::server::execop::reply (c++ function)": [[16, "_CPPv4N4pvxs6server6ExecOp5replyERK5Value"], [16, "_CPPv4N4pvxs6server6ExecOp5replyEv"]], "pvxs::server::monitorcontrolop (c++ struct)": [[16, "_CPPv4N4pvxs6server16MonitorControlOpE"]], "pvxs::server::monitorcontrolop::finish (c++ function)": [[16, "_CPPv4N4pvxs6server16MonitorControlOp6finishEv"]], "pvxs::server::monitorcontrolop::forcepost (c++ function)": [[16, "_CPPv4N4pvxs6server16MonitorControlOp9forcePostERK5Value"]], "pvxs::server::monitorcontrolop::onstart (c++ function)": [[16, "_CPPv4N4pvxs6server16MonitorControlOp7onStartERRNSt8functionIFvbEEE"]], "pvxs::server::monitorcontrolop::post (c++ function)": [[16, "_CPPv4N4pvxs6server16MonitorControlOp4postERK5Value"]], "pvxs::server::monitorcontrolop::setwatermarks (c++ function)": [[16, "_CPPv4N4pvxs6server16MonitorControlOp13setWatermarksE6size_t6size_t"]], "pvxs::server::monitorcontrolop::stats (c++ function)": [[16, "_CPPv4NK4pvxs6server16MonitorControlOp5statsER11MonitorStatb"]], "pvxs::server::monitorcontrolop::trypost (c++ function)": [[16, "_CPPv4N4pvxs6server16MonitorControlOp7tryPostERK5Value"]], "pvxs::server::monitorsetupop (c++ struct)": [[16, "_CPPv4N4pvxs6server14MonitorSetupOpE"]], "pvxs::server::monitorsetupop::connect (c++ function)": [[16, "_CPPv4N4pvxs6server14MonitorSetupOp7connectERK5Value"]], "pvxs::server::monitorsetupop::error (c++ function)": [[16, "_CPPv4N4pvxs6server14MonitorSetupOp5errorERKNSt6stringE"]], "pvxs::server::monitorstat (c++ struct)": [[16, "_CPPv4N4pvxs6server11MonitorStatE"]], "pvxs::server::monitorstat::limitqueue (c++ member)": [[16, "_CPPv4N4pvxs6server11MonitorStat10limitQueueE"]], "pvxs::server::monitorstat::maxqueue (c++ member)": [[16, "_CPPv4N4pvxs6server11MonitorStat8maxQueueE"]], "pvxs::server::monitorstat::nqueue (c++ member)": [[16, "_CPPv4N4pvxs6server11MonitorStat6nQueueE"]], "pvxs::server::monitorstat::nsquash (c++ member)": [[16, "_CPPv4N4pvxs6server11MonitorStat7nSquashE"]], "pvxs::server::monitorstat::window (c++ member)": [[16, "_CPPv4N4pvxs6server11MonitorStat6windowE"]], "pvxs::server::opbase (c++ struct)": [[16, "_CPPv4N4pvxs6server6OpBaseE"]], "pvxs::server::opbase::credentials (c++ function)": [[16, "_CPPv4NK4pvxs6server6OpBase11credentialsEv"]], "pvxs::server::opbase::name (c++ function)": [[16, "_CPPv4NK4pvxs6server6OpBase4nameEv"]], "pvxs::server::opbase::op (c++ function)": [[16, "_CPPv4NK4pvxs6server6OpBase2opEv"]], "pvxs::server::opbase::peername (c++ function)": [[16, "_CPPv4NK4pvxs6server6OpBase8peerNameEv"]], "pvxs::server::source (c++ struct)": [[16, "_CPPv4N4pvxs6server6SourceE"]], "pvxs::server::source::list (c++ struct)": [[16, "_CPPv4N4pvxs6server6Source4ListE"]], "pvxs::server::source::list::dynamic (c++ member)": [[16, "_CPPv4N4pvxs6server6Source4List7dynamicE"]], "pvxs::server::source::list::names (c++ member)": [[16, "_CPPv4N4pvxs6server6Source4List5namesE"]], "pvxs::server::source::search (c++ struct)": [[16, "_CPPv4N4pvxs6server6Source6SearchE"]], "pvxs::server::source::search::name (c++ class)": [[16, "_CPPv4N4pvxs6server6Source6Search4NameE"]], "pvxs::server::source::search::name::claim (c++ function)": [[16, "_CPPv4N4pvxs6server6Source6Search4Name5claimEv"]], "pvxs::server::source::search::name::name (c++ function)": [[16, "_CPPv4NK4pvxs6server6Source6Search4Name4nameEv"]], "pvxs::server::source::search::begin (c++ function)": [[16, "_CPPv4N4pvxs6server6Source6Search5beginEv"]], "pvxs::server::source::search::end (c++ function)": [[16, "_CPPv4N4pvxs6server6Source6Search3endEv"]], "pvxs::server::source::search::size (c++ function)": [[16, "_CPPv4NK4pvxs6server6Source6Search4sizeEv"]], "pvxs::server::source::search::source (c++ function)": [[16, "_CPPv4NK4pvxs6server6Source6Search6sourceEv"]], "pvxs::server::source::oncreate (c++ function)": [[16, "_CPPv4N4pvxs6server6Source8onCreateERRNSt10unique_ptrI14ChannelControlEE"]], "pvxs::server::source::onlist (c++ function)": [[16, "_CPPv4N4pvxs6server6Source6onListEv"]], "pvxs::server::source::onsearch (c++ function)": [[16, "_CPPv4N4pvxs6server6Source8onSearchER6Search"]], "pvxs::server::source::show (c++ function)": [[16, "_CPPv4N4pvxs6server6Source4showERNSt7ostreamE"]], "pvxs::kind (c++ enum)": [[17, "_CPPv4N4pvxs4KindE"]], "pvxs::kind::bool (c++ enumerator)": [[17, "_CPPv4N4pvxs4Kind4BoolE"]], "pvxs::kind::compound (c++ enumerator)": [[17, "_CPPv4N4pvxs4Kind8CompoundE"]], "pvxs::kind::integer (c++ enumerator)": [[17, "_CPPv4N4pvxs4Kind7IntegerE"]], "pvxs::kind::null (c++ enumerator)": [[17, "_CPPv4N4pvxs4Kind4NullE"]], "pvxs::kind::real (c++ enumerator)": [[17, "_CPPv4N4pvxs4Kind4RealE"]], "pvxs::kind::string (c++ enumerator)": [[17, "_CPPv4N4pvxs4Kind6StringE"]], "pvxs::member (c++ struct)": [[17, "_CPPv4N4pvxs6MemberE"]], "pvxs::member::member (c++ function)": [[17, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringE"], [17, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringENSt16initializer_listI6MemberEE"], [17, "_CPPv4N4pvxs6Member6MemberE8TypeCodeRKNSt6stringERKNSt6stringENSt16initializer_listI6MemberEE"], [17, "_CPPv4N4pvxs6Member6MemberEv"]], "pvxs::typecode (c++ struct)": [[17, "_CPPv4N4pvxs8TypeCodeE"]], "pvxs::typecode::arrayof (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode7arrayOfEv"]], "pvxs::typecode::code (c++ member)": [[17, "_CPPv4N4pvxs8TypeCode4codeE"]], "pvxs::typecode::code_t (c++ enum)": [[17, "_CPPv4N4pvxs8TypeCode6code_tE"]], "pvxs::typecode::code_t::any (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t3AnyE"]], "pvxs::typecode::code_t::anya (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t4AnyAE"]], "pvxs::typecode::code_t::bool (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t4BoolE"]], "pvxs::typecode::code_t::boola (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5BoolAE"]], "pvxs::typecode::code_t::float32 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7Float32E"]], "pvxs::typecode::code_t::float32a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t8Float32AE"]], "pvxs::typecode::code_t::float64 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7Float64E"]], "pvxs::typecode::code_t::float64a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t8Float64AE"]], "pvxs::typecode::code_t::int16 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5Int16E"]], "pvxs::typecode::code_t::int16a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6Int16AE"]], "pvxs::typecode::code_t::int32 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5Int32E"]], "pvxs::typecode::code_t::int32a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6Int32AE"]], "pvxs::typecode::code_t::int64 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5Int64E"]], "pvxs::typecode::code_t::int64a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6Int64AE"]], "pvxs::typecode::code_t::int8 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t4Int8E"]], "pvxs::typecode::code_t::int8a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5Int8AE"]], "pvxs::typecode::code_t::null (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t4NullE"]], "pvxs::typecode::code_t::string (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6StringE"]], "pvxs::typecode::code_t::stringa (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7StringAE"]], "pvxs::typecode::code_t::struct (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6StructE"]], "pvxs::typecode::code_t::structa (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7StructAE"]], "pvxs::typecode::code_t::uint16 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6UInt16E"]], "pvxs::typecode::code_t::uint16a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7UInt16AE"]], "pvxs::typecode::code_t::uint32 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6UInt32E"]], "pvxs::typecode::code_t::uint32a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7UInt32AE"]], "pvxs::typecode::code_t::uint64 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6UInt64E"]], "pvxs::typecode::code_t::uint64a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t7UInt64AE"]], "pvxs::typecode::code_t::uint8 (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5UInt8E"]], "pvxs::typecode::code_t::uint8a (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6UInt8AE"]], "pvxs::typecode::code_t::union (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t5UnionE"]], "pvxs::typecode::code_t::uniona (c++ enumerator)": [[17, "_CPPv4N4pvxs8TypeCode6code_t6UnionAE"]], "pvxs::typecode::isarray (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode7isarrayEv"]], "pvxs::typecode::isunsigned (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode10isunsignedEv"]], "pvxs::typecode::name (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode4nameEv"]], "pvxs::typecode::order (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode5orderEv"]], "pvxs::typecode::scalarof (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode8scalarOfEv"]], "pvxs::typecode::size (c++ function)": [[17, "_CPPv4NK4pvxs8TypeCode4sizeEv"]], "pvxs::typedef (c++ class)": [[17, "_CPPv4N4pvxs7TypeDefE"]], "pvxs::typedef::typedef (c++ function)": [[17, "_CPPv4I0EN4pvxs7TypeDef7TypeDefE8TypeCodeRKNSt6stringERK8Iterable"], [17, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCode"], [17, "_CPPv4N4pvxs7TypeDef7TypeDefE8TypeCodeNSt16initializer_listI6MemberEE"], [17, "_CPPv4N4pvxs7TypeDef7TypeDefERK5Value"], [17, "_CPPv4N4pvxs7TypeDef7TypeDefEv"]], "pvxs::typedef::as (c++ function)": [[17, "_CPPv4NK4pvxs7TypeDef2asE8TypeCodeRKNSt6stringE"], [17, "_CPPv4NK4pvxs7TypeDef2asERKNSt6stringE"]], "pvxs::typedef::create (c++ function)": [[17, "_CPPv4NK4pvxs7TypeDef6createEv"]], "pvxs::typedef::operator+= (c++ function)": [[17, "_CPPv4I0EN4pvxs7TypeDefpLER7TypeDefRK8Iterable"]], "pvxs::members (c++ type)": [[17, "_CPPv4N4pvxs7membersE"]], "define_logger (c macro)": [[18, "c.DEFINE_LOGGER"]], "pvxs_abi_version (c macro)": [[18, "c.PVXS_ABI_VERSION"]], "pvxs_version (c macro)": [[18, "c.PVXS_VERSION"]], "version_int (c macro)": [[18, "c.VERSION_INT"]], "log_crit_printf (c macro)": [[18, "c.log_crit_printf"]], "log_debug_printf (c macro)": [[18, "c.log_debug_printf"]], "log_err_printf (c macro)": [[18, "c.log_err_printf"]], "log_info_printf (c macro)": [[18, "c.log_info_printf"]], "log_printf (c macro)": [[18, "c.log_printf"]], "log_warn_printf (c macro)": [[18, "c.log_warn_printf"]], "pvxs::level (c++ enum)": [[18, "_CPPv4N4pvxs5LevelE"]], "pvxs::level::crit (c++ enumerator)": [[18, "_CPPv4N4pvxs5Level4CritE"]], "pvxs::level::debug (c++ enumerator)": [[18, "_CPPv4N4pvxs5Level5DebugE"]], "pvxs::level::err (c++ enumerator)": [[18, "_CPPv4N4pvxs5Level3ErrE"]], "pvxs::level::info (c++ enumerator)": [[18, "_CPPv4N4pvxs5Level4InfoE"]], "pvxs::level::warn (c++ enumerator)": [[18, "_CPPv4N4pvxs5Level4WarnE"]], "pvxs::mpmcfifo (c++ class)": [[18, "_CPPv4I0EN4pvxs8MPMCFIFOE"]], "pvxs::mpmcfifo::mpmcfifo (c++ function)": [[18, "_CPPv4N4pvxs8MPMCFIFO8MPMCFIFOE6size_t"]], "pvxs::mpmcfifo::emplace (c++ function)": [[18, "_CPPv4IDpEN4pvxs8MPMCFIFO7emplaceEvDpRR4Args"]], "pvxs::mpmcfifo::pop (c++ function)": [[18, "_CPPv4N4pvxs8MPMCFIFO3popEv"]], "pvxs::mpmcfifo::push (c++ function)": [[18, "_CPPv4N4pvxs8MPMCFIFO4pushERK1T"], [18, "_CPPv4N4pvxs8MPMCFIFO4pushERR1T"]], "pvxs::mpmcfifo::size (c++ function)": [[18, "_CPPv4NK4pvxs8MPMCFIFO4sizeEv"]], "pvxs::mpmcfifo::value_type (c++ type)": [[18, "_CPPv4N4pvxs8MPMCFIFO10value_typeE"]], "pvxs::mpmcfifo::~mpmcfifo (c++ function)": [[18, "_CPPv4N4pvxs8MPMCFIFOD0Ev"]], "pvxs::sigint (c++ class)": [[18, "_CPPv4N4pvxs6SigIntE"]], "pvxs::cleanup_for_valgrind (c++ function)": [[18, "_CPPv4N4pvxs20cleanup_for_valgrindEv"]], "pvxs::escape (c++ function)": [[18, "_CPPv4N4pvxs6escapeEPKc"], [18, "_CPPv4N4pvxs6escapeEPKc6size_t"], [18, "_CPPv4N4pvxs6escapeERKNSt6stringE"]], "pvxs::ioc::testioc (c++ class)": [[18, "_CPPv4N4pvxs3ioc7TestIOCE"]], "pvxs::logger (c++ struct)": [[18, "_CPPv4N4pvxs6loggerE"]], "pvxs::logger::lvl (c++ member)": [[18, "_CPPv4N4pvxs6logger3lvlE"]], "pvxs::logger::name (c++ member)": [[18, "_CPPv4N4pvxs6logger4nameE"]], "pvxs::logger::test (c++ function)": [[18, "_CPPv4N4pvxs6logger4testE5Level"]], "pvxs::logger_config_env (c++ function)": [[18, "_CPPv4N4pvxs17logger_config_envEv"]], "pvxs::logger_level_clear (c++ function)": [[18, "_CPPv4N4pvxs18logger_level_clearEv"]], "pvxs::logger_level_set (c++ function)": [[18, "_CPPv4N4pvxs16logger_level_setEPKc5Level"]], "pvxs::target_information (c++ function)": [[18, "_CPPv4N4pvxs18target_informationERNSt7ostreamE"]], "pvxs::testcase (c++ class)": [[18, "_CPPv4N4pvxs8testCaseE"]], "pvxs::testcase::operator bool (c++ function)": [[18, "_CPPv4NK4pvxs8testCasecvbEv"]], "pvxs::testcase::operator<< (c++ function)": [[18, "_CPPv4I0EN4pvxs8testCaselsER8testCaseRK1T"]], "pvxs::testcase::setpass (c++ function)": [[18, "_CPPv4N4pvxs8testCase7setPassEb"]], "pvxs::testcase::setpassmatch (c++ function)": [[18, "_CPPv4N4pvxs8testCase12setPassMatchERKNSt6stringERKNSt6stringE"]], "pvxs::testcase::stream (c++ function)": [[18, "_CPPv4N4pvxs8testCase6streamEv"]], "pvxs::testcase::testcase (c++ function)": [[18, "_CPPv4N4pvxs8testCase8testCaseEb"], [18, "_CPPv4N4pvxs8testCase8testCaseEv"]], "pvxs::testthrows (c++ function)": [[18, "_CPPv4I00EN4pvxs10testThrowsE8testCase2FN"]], "pvxs::testthrowsmatch (c++ function)": [[18, "_CPPv4I00EN4pvxs15testThrowsMatchE8testCaseRKNSt6stringE2FN"]], "pvxs::version_abi_check (c++ function)": [[18, "_CPPv4N4pvxs17version_abi_checkEv"]], "pvxs::version_abi_int (c++ function)": [[18, "_CPPv4N4pvxs15version_abi_intEv"]], "pvxs::version_int (c++ function)": [[18, "_CPPv4N4pvxs11version_intEv"]], "pvxs::version_str (c++ function)": [[18, "_CPPv4N4pvxs11version_strEv"]], "testarreq (c macro)": [[18, "c.testArrEq"]], "testeq (c macro)": [[18, "c.testEq"]], "testfalse (c macro)": [[18, "c.testFalse"]], "testnoteq (c macro)": [[18, "c.testNotEq"]], "testshow (c macro)": [[18, "c.testShow"]], "teststreq (c macro)": [[18, "c.testStrEq"]], "teststrmatch (c macro)": [[18, "c.testStrMatch"]], "testtrue (c macro)": [[18, "c.testTrue"]], "pvxs::arraytype (c++ enum)": [[19, "_CPPv4N4pvxs9ArrayTypeE"]], "pvxs::arraytype::bool (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType4BoolE"]], "pvxs::arraytype::float32 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType7Float32E"]], "pvxs::arraytype::float64 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType7Float64E"]], "pvxs::arraytype::int16 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType5Int16E"]], "pvxs::arraytype::int32 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType5Int32E"]], "pvxs::arraytype::int64 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType5Int64E"]], "pvxs::arraytype::int8 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType4Int8E"]], "pvxs::arraytype::null (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType4NullE"]], "pvxs::arraytype::string (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType6StringE"]], "pvxs::arraytype::uint16 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType6UInt16E"]], "pvxs::arraytype::uint32 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType6UInt32E"]], "pvxs::arraytype::uint64 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType6UInt64E"]], "pvxs::arraytype::uint8 (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType5UInt8E"]], "pvxs::arraytype::value (c++ enumerator)": [[19, "_CPPv4N4pvxs9ArrayType5ValueE"]], "pvxs::lookuperror (c++ struct)": [[19, "_CPPv4N4pvxs11LookupErrorE"]], "pvxs::noconvert (c++ struct)": [[19, "_CPPv4N4pvxs9NoConvertE"]], "pvxs::nofield (c++ struct)": [[19, "_CPPv4N4pvxs7NoFieldE"]], "pvxs::value (c++ class)": [[19, "_CPPv4N4pvxs5ValueE"]], "pvxs::value::fmt (c++ struct)": [[19, "_CPPv4N4pvxs5Value3FmtE"]], "pvxs::value::fmt::arraylimit (c++ function)": [[19, "_CPPv4N4pvxs5Value3Fmt10arrayLimitE6size_t"]], "pvxs::value::fmt::delta (c++ function)": [[19, "_CPPv4N4pvxs5Value3Fmt5deltaEv"]], "pvxs::value::fmt::format (c++ function)": [[19, "_CPPv4N4pvxs5Value3Fmt6formatE8format_t"]], "pvxs::value::fmt::showvalue (c++ function)": [[19, "_CPPv4N4pvxs5Value3Fmt9showValueEb"]], "pvxs::value::fmt::tree (c++ function)": [[19, "_CPPv4N4pvxs5Value3Fmt4treeEv"]], "pvxs::value::iterable (c++ struct)": [[19, "_CPPv4I0EN4pvxs5Value8IterableE"]], "pvxs::value::value (c++ function)": [[19, "_CPPv4N4pvxs5Value5ValueEv"]], "pvxs::value::_iall (c++ struct)": [[19, "_CPPv4N4pvxs5Value5_IAllE"]], "pvxs::value::_ichildren (c++ struct)": [[19, "_CPPv4N4pvxs5Value10_IChildrenE"]], "pvxs::value::_imarked (c++ struct)": [[19, "_CPPv4N4pvxs5Value8_IMarkedE"]], "pvxs::value::allocmember (c++ function)": [[19, "_CPPv4N4pvxs5Value11allocMemberEv"]], "pvxs::value::as (c++ function)": [[19, "_CPPv4I00ENK4pvxs5Value2asEN4impl10StorageMapIN11typenamestd5decayI2FNE4typeEE12not_storableERR2FN"], [19, "_CPPv4I0ENK4pvxs5Value2asE1Tv"], [19, "_CPPv4I0ENK4pvxs5Value2asEbR1T"]], "pvxs::value::assign (c++ function)": [[19, "_CPPv4N4pvxs5Value6assignERK5Value"]], "pvxs::value::clear (c++ function)": [[19, "_CPPv4N4pvxs5Value5clearEv"]], "pvxs::value::clone (c++ function)": [[19, "_CPPv4NK4pvxs5Value5cloneEv"]], "pvxs::value::cloneempty (c++ function)": [[19, "_CPPv4NK4pvxs5Value10cloneEmptyEv"]], "pvxs::value::equalinst (c++ function)": [[19, "_CPPv4NK4pvxs5Value9equalInstERK5Value"]], "pvxs::value::equaltype (c++ function)": [[19, "_CPPv4NK4pvxs5Value9equalTypeERK5Value"]], "pvxs::value::format (c++ function)": [[19, "_CPPv4NK4pvxs5Value6formatEv"]], "pvxs::value::from (c++ function)": [[19, "_CPPv4I0EN4pvxs5Value4fromEvRK1T"]], "pvxs::value::iall (c++ function)": [[19, "_CPPv4NK4pvxs5Value4iallEv"]], "pvxs::value::ichildren (c++ function)": [[19, "_CPPv4NK4pvxs5Value9ichildrenEv"]], "pvxs::value::id (c++ function)": [[19, "_CPPv4NK4pvxs5Value2idEv"]], "pvxs::value::idstartswith (c++ function)": [[19, "_CPPv4NK4pvxs5Value12idStartsWithERKNSt6stringE"]], "pvxs::value::ifmarked (c++ function)": [[19, "_CPPv4NK4pvxs5Value8ifMarkedEbb"]], "pvxs::value::imarked (c++ function)": [[19, "_CPPv4NK4pvxs5Value7imarkedEv"]], "pvxs::value::ismarked (c++ function)": [[19, "_CPPv4NK4pvxs5Value8isMarkedEbb"]], "pvxs::value::lookup (c++ function)": [[19, "_CPPv4N4pvxs5Value6lookupERKNSt6stringE"]], "pvxs::value::mark (c++ function)": [[19, "_CPPv4N4pvxs5Value4markEb"]], "pvxs::value::nameof (c++ function)": [[19, "_CPPv4NK4pvxs5Value6nameOfERK5Value"]], "pvxs::value::nmembers (c++ function)": [[19, "_CPPv4NK4pvxs5Value8nmembersEv"]], "pvxs::value::operator= (c++ function)": [[19, "_CPPv4I0EN4pvxs5ValueaSER5ValueRK1T"]], "pvxs::value::operator[] (c++ function)": [[19, "_CPPv4N4pvxs5ValueixERKNSt6stringE"]], "pvxs::value::storagetype (c++ function)": [[19, "_CPPv4NK4pvxs5Value11storageTypeEv"]], "pvxs::value::tryfrom (c++ function)": [[19, "_CPPv4I0EN4pvxs5Value7tryFromEbRK1T"]], "pvxs::value::type (c++ function)": [[19, "_CPPv4NK4pvxs5Value4typeEv"]], "pvxs::value::unmark (c++ function)": [[19, "_CPPv4N4pvxs5Value6unmarkEbb"]], "pvxs::value::update (c++ function)": [[19, "_CPPv4I00EN4pvxs5Value6updateER5Value1KRK1T"]], "pvxs::value::valid (c++ function)": [[19, "_CPPv4NK4pvxs5Value5validEv"]], "pvxs::detail::limiter (c++ class)": [[19, "_CPPv4N4pvxs6detail7LimiterE"]], "pvxs::detail::limiter::limit (c++ function)": [[19, "_CPPv4N4pvxs6detail7Limiter5limitE6size_t"]], "pvxs::elementsize (c++ function)": [[19, "_CPPv4N4pvxs11elementSizeE9ArrayType"]], "pvxs::shared_array (c++ class)": [[19, "_CPPv4I00EN4pvxs12shared_arrayE"]], "pvxs::shared_array::at (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array2atE6size_t"]], "pvxs::shared_array::begin (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array5beginEv"]], "pvxs::shared_array::castto (c++ function)": [[19, "_CPPv4I0ENK4pvxs12shared_array6castToE12shared_arrayI2TOEv"]], "pvxs::shared_array::clear (c++ function)": [[19, "_CPPv4N4pvxs12shared_array5clearEv"]], "pvxs::shared_array::convertto (c++ function)": [[19, "_CPPv4I0ENK4pvxs12shared_array9convertToE12shared_arrayI2TOEv"]], "pvxs::shared_array::data (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array4dataEv"]], "pvxs::shared_array::empty (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array5emptyEv"]], "pvxs::shared_array::end (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array3endEv"]], "pvxs::shared_array::format (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array6formatEv"]], "pvxs::shared_array::freeze (c++ function)": [[19, "_CPPv4N4pvxs12shared_array6freezeEv"]], "pvxs::shared_array::make_unique (c++ function)": [[19, "_CPPv4N4pvxs12shared_array11make_uniqueEv"]], "pvxs::shared_array::operator[] (c++ function)": [[19, "_CPPv4NK4pvxs12shared_arrayixE6size_t"]], "pvxs::shared_array::original_type (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array13original_typeEv"]], "pvxs::shared_array::resize (c++ function)": [[19, "_CPPv4N4pvxs12shared_array6resizeE6size_t"]], "pvxs::shared_array::shared_array (c++ function)": [[19, "_CPPv4I0EN4pvxs12shared_array12shared_arrayE6size_t1V"], [19, "_CPPv4I0EN4pvxs12shared_array12shared_arrayENSt16initializer_listI1AEE"], [19, "_CPPv4I0EN4pvxs12shared_array12shared_arrayEP1E1B6size_t"], [19, "_CPPv4I0EN4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1AEEP1E6size_t"], [19, "_CPPv4I0_NSt15iterator_traitsI4IterE15difference_typeEEN4pvxs12shared_array12shared_arrayE4Iter4Iter"], [19, "_CPPv4N4pvxs12shared_array12shared_arrayE6size_t"], [19, "_CPPv4N4pvxs12shared_array12shared_arrayEP1E6size_t"], [19, "_CPPv4N4pvxs12shared_array12shared_arrayERKNSt10shared_ptrI1EEE6size_t"]], "pvxs::shared_array::size (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array4sizeEv"]], "pvxs::shared_array::swap (c++ function)": [[19, "_CPPv4N4pvxs12shared_array4swapER12shared_array"]], "pvxs::shared_array::thaw (c++ function)": [[19, "_CPPv4N4pvxs12shared_array4thawEv"]], "pvxs::shared_array::unique (c++ function)": [[19, "_CPPv4NK4pvxs12shared_array6uniqueEv"]]}}) \ No newline at end of file diff --git a/server.html b/server.html new file mode 100644 index 000000000..189ee1ebf --- /dev/null +++ b/server.html @@ -0,0 +1,455 @@ + + + + + + + + + Server API — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Server API

+
+

Contents:

+ +
+

pvxs::server::Server represents a PVA protocol server.

+
#include <pvxs/server.h>
+namespace pvxs { namespace server { ... } }
+
+
+

The basic recipe to run a server using configuration from the process environment is:

+
auto serv = server::Config::fromEnv()
+            .build()
+// calls to serv.addPV() or serv.addSource()
+serv.run(); // run intil SIGINT or serv.interrupt()
+// could also call serv.start() and later serv.stop()
+
+
+

A useful server will have one or more pvxs::server::Source instances added to it with addSource() method. +Common usage will be with pvxs::server::StaticSource and one or more pvxs::server::SharedPV.

+

If more than one Source is added, then an order of precedence is established through +the “order” argument of addSource(). In the event that more than one Source could +provide/claim a given PV name, the Source with the lowest “order” will win.

+
+

Configuration

+

The recommended starting point when configuring a Server is pvxs::server::Config::fromEnv() +which will use the following Environment variables when set.

+

Entries naming multiple Environment variables will prefer the left most which is set. +eg. EPICS_PVA_ADDR_LIST is only checked if EPICS_PVAS_BEACON_ADDR_LIST is unset.

+
+
EPICS_PVAS_INTF_ADDR_LIST

Space separated list of local interface addresses to which the server will bind. +Port numbers are parsed and ignore. +Sets pvxs::server::Config::interfaces

+
+
EPICS_PVAS_BEACON_ADDR_LIST or EPICS_PVA_ADDR_LIST

Space separated list of unicast or broadcast addresses. +This list is supplimented all local broadcast addresses if auto-beacon is YES. +Sets pvxs::server::Config::beaconDestinations

+
+
EPICS_PVAS_AUTO_BEACON_ADDR_LIST or EPICS_PVA_AUTO_ADDR_LIST

YES or NO. +Sets pvxs::server::Config::auto_beacon

+
+
EPICS_PVAS_SERVER_PORT or EPICS_PVA_SERVER_PORT

Single integer. +Preferred TCP port to bind. +If already in use then a random port will be chosen. +Sets pvxs::server::Config::tcp_port

+
+
EPICS_PVAS_BROADCAST_PORT or EPICS_PVA_BROADCAST_PORT

Single integer. +UDP port to bind. +If already in use, then an exception is thrown. +Sets pvxs::server::Config::udp_port

+
+
EPICS_PVAS_IGNORE_ADDR_LIST

Space separated list of addresses with optional port. +Port zero is treated as a wildcard to match any port. +UDP traffic from matched addresses will be ignored with no further processing.

+
+
EPICS_PVA_CONN_TMO

Inactivity timeout for TCP connections. For compatibility with pvAccessCPP +a multiplier of 4/3 is applied. So a value of 30 results in a 40 second timeout.

+
+
+
+

New in version 0.3.0: All *_ADDR_LIST may contain IPv4 multicast, and IPv6 uni/multicast addresses.

+
+
+

New in version 0.2.0: Prior to 0.2.0 EPICS_PVA_CONN_TMO was ignored.

+
+
+
+struct Config
+

Configuration for a Server.

+
+

Public Functions

+
+
+Config &applyEnv()
+

update using defined EPICS_PVA* environment variables

+
+ +
+
+Config &applyDefs(const defs_t &def)
+

update with definitions as with EPICS_PVA* environment variables. Process environment is not changed.

+
+ +
+
+void updateDefs(defs_t &defs) const
+

extract definitions with environment variable names as keys. Process environment is not changed.

+
+ +
+
+void expand()
+

Apply rules to translate current requested configuration into one which can actually be loaded based on current host network configuration.

+

Explicit use of expand() is optional as the Context ctor expands any Config given. expand() is provided as a aid to help understand how Context::effective() is arrived at.

+
+
Post:
+

autoAddrList==false

+
+
+
+ +
+
+inline Server build() const
+

Create a new Server using the current configuration.

+
+ +
+
+

Public Members

+
+
+std::vector<std::string> interfaces
+

List of network interface addresses (not host names) to which this server will bind. interfaces.empty() treated as an alias for “0.0.0.0”, which may also be given explicitly. Port numbers are optional and unused (parsed and ignored)

+
+ +
+
+std::vector<std::string> ignoreAddrs
+

Ignore client requests originating from addresses in this list. Entries must be IP addresses with optional port numbers. Port number zero (default) is treated as a wildcard which matches any port.

+
Since

0.2.0

+
+
+

+
+ +
+
+std::vector<std::string> beaconDestinations
+

Addresses (not host names) to which (UDP) beacons message will be sent. May include broadcast and/or unicast addresses. Supplemented only if auto_beacon==true

+
+ +
+
+unsigned short tcp_port = 5075
+

TCP port to bind. Default is 5075. May be zero.

+
+ +
+
+unsigned short udp_port = 5076
+

UDP port to bind. Default is 5076. May be zero, cf. Server::config() to find allocated port.

+
+ +
+
+bool auto_beacon = true
+

Whether to populate the beacon address list automatically. (recommended)

+
+ +
+
+double tcpTimeout = 40.0
+

Inactivity timeout interval for TCP connections. (seconds)

+
Since

0.2.0

+
+
+

+
+ +
+
+ServerGUID guid = {}
+

Server unique ID. Only meaningful in readback via Server::config()

+
+ +
+
+

Public Static Functions

+
+
+static inline Config fromEnv()
+

Default configuration using process environment.

+
+ +
+
+static Config isolated(int family = AF_INET)
+

Configuration limited to the local loopback interface on a randomly chosen port. Suitable for use in self-contained unit-tests.

+
Since

0.3.0 Address family argument added.

+
+
+

+
+ +
+
+ +
+
+class Server
+

PV Access protocol server instance

+

Use a Config to determine how this server will bind, listen, and announce itself.

+

In order to be useful, a Server will have one or more Source instances added to it with addSource().

+

As a convenience, each Server instance automatically contains a “__builtin” StaticSource to which SharedPV instances can be directly added. The “__builtin” has priority zero, and can be accessed or even removed like any Source explicitly added with addSource().

+

There is also a “__server” source which provides the special “server” PV used by the pvlist CLI.

+
+

Public Functions

+
+
+constexpr Server() = default
+

An empty/dummy Server.

+
+ +
+
+explicit Server(const Config&)
+

Create/allocate, but do not start, a new server with the provided config.

+
+ +
+
+Server &start()
+

Begin serving. Does not block.

+
+ +
+
+Server &stop()
+

Stop server.

+
+ +
+
+Server &run()
+

start() and then (maybe) stop()

+

run() may be interrupted by calling interrupt(), or by SIGINT or SIGTERM (only one Server per process)

+

Intended to simple CLI programs. Only one Server in a process may be in run() at any moment. Other use case should call start()/stop()

+
+ +
+
+Server &interrupt()
+

Queue a request to break run()

+
+ +
+
+const Config &config() const
+

effective config

+
+ +
+
+client::Config clientConfig() const
+

Create a client configuration which can communicate with this Server. Suitable for use in self-contained unit-tests.

+
+ +
+
+Server &addPV(const std::string &name, const SharedPV &pv)
+

Add a SharedPV to the “__builtin” StaticSource.

+
+ +
+
+Server &removePV(const std::string &name)
+

Remove a SharedPV from the “__builtin” StaticSource.

+
+ +
+
+Server &addSource(const std::string &name, const std::shared_ptr<Source> &src, int order = 0)
+

Add a Source to this server with an arbitrary source name.

+

Source names beginning with “__” are reserved for internal use. eg. “__builtin” and “__server”.

+
+
Parameters:
+
+
+
Throws:
+

std::runtime_error – If this (name, order) has already been added.

+
+
+
+ +
+
+std::shared_ptr<Source> removeSource(const std::string &name, int order = 0)
+

Disassociate a Source using the name and priority given to addSource()

+
+ +
+
+std::shared_ptr<Source> getSource(const std::string &name, int order = 0)
+

Fetch a previously added Source.

+
+ +
+
+std::vector<std::pair<std::string, int>> listSource()
+

List all source names and priorities.

+
+ +
+
+

Public Static Functions

+
+
+static Server fromEnv()
+

Create new server based on configuration from $EPICS_PVA* environment variables.

+

Shorthand for 

Config::fromEnv().build() 
+
+
+.
+
Since

0.2.1

+
+
+

+
+ +
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/sharedpv.html b/sharedpv.html new file mode 100644 index 000000000..928cec4be --- /dev/null +++ b/sharedpv.html @@ -0,0 +1,336 @@ + + + + + + + + + SharedPV and StaticSource — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

SharedPV and StaticSource

+

A SharedPV is a single data value which may be accessed by multiple clients through a Server. +It is “shared” in the sense that all clients are manipulating a single variable.

+
#include <pvxs/sharedpv.h>
+namespace pvxs { namespace server { ... } }
+
+
+

Each SharedPV instance has (after open() ) an associated data structure +which is later manipulated with post().

+

A simple usage is:

+
using namespace pvxs;
+
+auto initial = nt::NTScalar{TypeCode::Float64}.create();
+initial["value"] = 42.0;
+
+auto src(server::StaticSource::build());
+
+auto pv(server::SharedPV::buildMailbox());
+pv.open(initial);
+
+src.add(argv[1], pv);
+
+auto serv = server::Server::Config::fromEnv()
+        .build()
+        .addSource("box", src.source());
+
+serv.run();
+
+
+

In this context “mailbox” refers to the default onPut() handler, which simply post()s whatever +the client sends.

+

An example of a SharedPV with a custom Put handler

+
auto pv(server::SharedPV::buildMailbox());
+
+pv.opPut([](server::SharedPV& pv,
+            std::unique_ptr<server::ExecOp>&& op,
+            Value&& top)
+{
+    // We decide that .value will be present with .open()
+    auto val = top["value"];
+    // is client trying to change .value ?
+    if(val.isMarked(true, true)) {
+        auto val = top["value"].as<double>();
+
+        // clip to range [0, 10]
+        top["value"] = std::max(0.0, std::min(val, 10.0));
+    }
+
+    // update and send to subscribers
+    pv.post(std::move(top));
+    // notify client of success  (or call op->error() if not)
+    op->reply();
+});
+
+auto initial = nt::NTScalar{TypeCode::Float64}.create();
+initial["value"] = 42.0;
+
+auto src(server::StaticSource::build());
+
+pv.open(initial);
+
+
+
+

Note

+

SharedPV follows the Source rules for Threading and locking.

+
+
+
+struct SharedPV
+

A SharedPV is a single data value which may be accessed by multiple clients through a Server.

+

On creation a SharedPV has no associated data structure, or data type. This is set by calling open() to provide a data type, and initial data values. Subsequent calls to post() will update this data structure (and send notifications to subscribing clients).

+

A later call to close() will force disconnect all clients, and discard the data value and type. A further call to open() sets a new data value, which may be of a different data type.

+

The onPut() and onRPC() methods attach functors which will be called each time a Put or RPC operation is executed by a client.

+
+

Public Functions

+
+
+void attach(std::unique_ptr<ChannelControl> &&op)
+

Attach this SharedPV with a new client channel. Not necessary when using StaticSource. eg. could call from Source::onCreate()

+
+ +
+
+void onFirstConnect(std::function<void(SharedPV&)> &&fn)
+

Callback when the number of attach()d clients becomes non-zero.

+
+ +
+
+void onLastDisconnect(std::function<void(SharedPV&)> &&fn)
+

Callback when the number of attach()d clients becomes zero.

+
+ +
+
+void onPut(std::function<void(SharedPV&, std::unique_ptr<ExecOp>&&, Value&&)> &&fn)
+

Callback when a client executes a new Put operation.

+
+ +
+
+void onRPC(std::function<void(SharedPV&, std::unique_ptr<ExecOp>&&, Value&&)> &&fn)
+

Callback when a client executes an RPC operation.

+
+

Note

+

RPC operations are allowed even when the SharedPV is not opened (isOpen()==false)

+
+
+ +
+
+void open(const Value &initial)
+

Provide data type and initial value. Allows clients to begin connecting.

+
+
Parameters:
+

initial – Defines data type, and initial value

+
+
Pre:
+

!isOpen()

+
+
+
+ +
+
+bool isOpen() const
+

Test whether open() has been called w/o matching close()

+
+ +
+
+void close()
+

Reverse the effects of open() and force disconnect any remaining clients.

+
+ +
+
+void post(const Value &val)
+

Update the internal data value, and dispatch subscription updates to any clients.

+
+ +
+
+void fetch(Value &val) const
+

query the internal data value and update the provided Value.

+
+ +
+
+Value fetch() const
+

Return a (shallow) copy of the internal data value.

+
+ +
+
+

Public Static Functions

+
+
+static SharedPV buildMailbox()
+

Create a new SharedPV with a Put handler which post() s any client provided Value.

+
+ +
+
+static SharedPV buildReadonly()
+

Create a new SharedPV with a Put handler which rejects any client provided Value.

+
+ +
+
+ +
+
+struct StaticSource
+

Allow clients to find (through a Server) SharedPV instances by name.

+

A single PV name may only be added once to a StaticSource. However, a single SharedPV may be added multiple times with different PV names.

+
+

Public Functions

+
+
+std::shared_ptr<Source> source() const
+

Fetch the Source interface, which may be used with Server::addSource()

+
+ +
+
+void close()
+

call SharedPV::close() on all PVs

+
+ +
+
+StaticSource &add(const std::string &name, const SharedPV &pv)
+

Add a new name through which a SharedPV may be addressed.

+
+ +
+
+StaticSource &remove(const std::string &name)
+

Remove a single name.

+
+ +
+
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/source.html b/source.html new file mode 100644 index 000000000..49c7159bf --- /dev/null +++ b/source.html @@ -0,0 +1,685 @@ + + + + + + + + + Data Source — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Data Source

+

The low-level API through which a pvxs::server::Server may issue requests on behalf of remote clients.

+
#include <pvxs/server.h>
+namespace pvxs { namespace server { ... } }
+
+
+

The pvxs::server::SharedPV API should be preferred when a Server has a predetermined set of PV names.

+

The pvxs::server::Source interface is a more general, and complex, means of allowing a Server +to respond to PV names as clients search for them. +This may be necessary in specialized cases such as gateway, proxy, or bridge servers.

+
+

Threading

+

A Server will invoke user callback functions from one or more internal worker threads. +However, it is guaranteed that callbacks relating to a given PV will never be executed concurrently. +This implies that callbacks for a single operation, +those stored through a pvxs::server::ChannelControl and related *Op, +will also never be executed concurrently.

+
+
+

Ownership and Lifetime

+

The *Op classes are interfaces through which callback functors are passed. +These functors are stored in underlying, and otherwise hidden, server data structures. +Therefore, it is safe to eg. capture a shared_ptr<ExecOp> into an onCancel +functor without creating a reference loop.

+

The lifetime of these server data structures are tied to the remote client. +So variables captured into a functor like pvxs::server::ConnectOp::onGet(), or onCancel, +will be destroyed when the client times out, closes the channel, or closes the operation. +Also when the server side forces channel closure via pvxs::server::ConnectOp::close. +The various *Close callbacks may also be used if explicit cleanup is needed on +certain conditions.

+
+
+

API

+
+
+struct Source
+

Interface through which a Server discovers Channel names and associates with Handler instances.

+

User code will sub-class.

+
+

Public Functions

+
+
+virtual void onSearch(Search &op) = 0
+

Called each time a client polls for the existence of some Channel names (Search::Name).

+

A Source may only Search::Name::claim() a Channel name if it is prepared to immediately accept an onCreate() call for that Channel name. In other situations it should wait for the client to retry.

+
+ +
+
+virtual void onCreate(std::unique_ptr<ChannelControl> &&op) = 0
+

A Client is attempting to open a connection to a certain Channel.

+

This Channel name may not be one which was seen or claimed by onSearch().

+

Callee may:

+

    +

  • Do nothing, allowing some other Source with higher/later order a chance to create.

    • +

  • Call ChannelControl::close() to explicitly reject the channel.

    • +

  • std::move() the op and/or call ChannelControl::setHandler() to accept the new channel.

    • +

  • std::move() the op and allow ChannelControl to be destroyed to implicitly reject the channel.

    • +
+

+
+ +
+
+virtual List onList()
+

A Client is requesting a list of Channel names which we may claim.

+
+ +
+
+virtual void show(std::ostream &strm)
+

Print status information.

+
+ +
+
+
+struct List
+

List of channel names.

+
+

Public Members

+
+
+std::shared_ptr<const std::set<std::string>> names
+

The list.

+
+ +
+
+bool dynamic
+

True if the list may change at some future time.

+
+ +
+
+ +
+
+struct Search
+

An iterable of names (Name) being sought.

+

virtual void onSearch(Search& search) {
+    for(auto& op : search) {
+        if(strcmp(op.name(), "magic")==0)
+            op.claim();
+    }
+}
+
+
+

+
+

Public Functions

+
+
+inline size_t size() const
+

Number of names.

+
+ +
+
+inline iterator begin()
+

Begin iterator of Name instances.

+
+ +
+
+inline iterator end()
+

End iterator of Name instances.

+
+ +
+
+inline const char *source() const
+

The Client endpoint address.

+
+ +
+
+
+class Name
+

A single name being searched.

+
+

Public Functions

+
+
+inline const char *name() const
+

The Channel name.

+
+ +
+
+inline void claim()
+

The caller claims to be able to respond to an onCreate() for this name.

+
+ +
+
+ +
+ +
+ +
+
+struct OpBase
+

Base for all operation classes.

+

Subclassed by pvxs::server::ChannelControl, pvxs::server::ConnectOp, pvxs::server::ExecOp, pvxs::server::MonitorControlOp, pvxs::server::MonitorSetupOp

+
+

Public Functions

+
+
+inline const std::string &peerName() const
+

The Client endpoint address in “X.X.X.X:Y” format.

+
+ +
+
+inline const std::string &name() const
+

The Channel name.

+
+ +
+
+inline const std::shared_ptr<const ClientCredentials> &credentials() const
+

Client credentials. Never NULL.

+
Since

0.2.0

+
+
+

+
+ +
+
+inline op_t op() const
+

Operation type.

+
+ +
+
+ +
+
+struct ExecOp : public pvxs::server::OpBase
+

Handle when an operation is being executed.

+
+

Public Functions

+
+
+virtual void reply() = 0
+

Issue a reply without data. (eg. to complete a PUT)

+
+ +
+
+virtual void reply(const Value &val) = 0
+

Issue a reply with data. For a GET or RPC (or PUT/Get)

+
+ +
+
+virtual void error(const std::string &msg) = 0
+

Indicate the request has resulted in an error.

+
Since

1.2.3 Does not block

+
+
+

+
+ +
+
+virtual void onCancel(std::function<void()>&&) = 0
+

Callback invoked if the peer cancels the operation before reply() or error() is called.

+
+ +
+
+inline const Value &pvRequest() const
+

Access to pvRequest blob

+
Since

0.2.0

+
+
+

+
+ +
+
+ +
+
+struct ConnectOp : public pvxs::server::OpBase
+

Handle when an operation is being setup.

+
+

Public Functions

+
+
+virtual void connect(const Value &prototype) = 0
+

For GET_FIELD, GET, or PUT. Inform peer of our data-type.

+
+
Throws:
+

std::runtime_error – if the client pvRequest() field mask does not select any fields of prototype.

+
+
+
+ +
+
+virtual void error(const std::string &msg) = 0
+

Indicate that this operation can not be setup

+
Since

1.2.3 Does not block

+
+
+

+
+ +
+
+virtual void onGet(std::function<void(std::unique_ptr<ExecOp>&&)> &&fn) = 0
+

Handler invoked when a peer executes a request for data on a GET o PUT.

+
+ +
+
+virtual void onPut(std::function<void(std::unique_ptr<ExecOp>&&, Value&&)> &&fn) = 0
+

Handler invoked when a peer executes a send data on a PUT.

+
+ +
+
+virtual void onClose(std::function<void(const std::string&)>&&) = 0
+

Callback when the underlying channel closes.

+
+ +
+
+ +
+
+struct MonitorControlOp : public pvxs::server::OpBase
+

Handle for active subscription.

+
+

Public Functions

+
+
+inline bool forcePost(const Value &val)
+

Add a new entry to the monitor queue. If nFree()<=0 the output queue will be over-filled with this element. Returns 

nFree()>0u 
+
+
+

+
+

Warning

+

Caller must not modify the Value

+
+
+ +
+
+inline bool post(const Value &val)
+

Add a new entry to the monitor queue. If nFree()<=0 this element will be “squashed” to the last element in the queue Returns 

nFree()>0u 
+
+
+

+
+

Warning

+

Caller must not modify the Value

+
+
+ +
+
+inline bool tryPost(const Value &val)
+

Add a new entry to the monitor queue. If nFree()<=0 return false and take no other action Returns 

nFree()>0u 
+
+
+

+
+

Warning

+

Caller must not modify the Value

+
+
+ +
+
+inline void finish()
+

Signal to subscriber that this subscription will not yield any further events. This is not an error. Client should not retry.

+
+ +
+
+virtual void stats(MonitorStat&, bool reset = false) const = 0
+

Poll information and statistics for this subscription.

+
Since

1.1.0 Added ‘reset’ argument.

+
+
+

+
+ +
+
+virtual void setWatermarks(size_t low, size_t high) = 0
+

Set flow control levels.

+

Flow control operations against an outbound “window” size, which is the number of updates which may be sent before a client ack. must be received. By default both high and low levels are zero.

+

onLowMark callback is not currently implemented and the ‘low’ level is not used. onHighMark callback will be invoked when a client ack. is received and the window size is above (>) ‘high’.

+
+ +
+
+virtual void onStart(std::function<void(bool start)>&&) = 0
+

Callback when client resumes/pauses updates.

+
+ +
+
+ +
+
+struct MonitorSetupOp : public pvxs::server::OpBase
+

Handle for subscription which is being setup.

+
+

Public Functions

+
+
+virtual std::unique_ptr<MonitorControlOp> connect(const Value &prototype) = 0
+

Inform peer of our data-type and acquire control of subscription queue. The queue is initially stopped.

+
+
Throws:
+

std::runtime_error – if the client pvRequest() field mask does not select any fields of prototype.

+
+
+
+ +
+
+virtual void error(const std::string &msg) = 0
+

Indicate that this operation can not be setup

+
Since

1.2.3 Does not block

+
+
+

+
+ +
+
+ +
+
+struct ChannelControl : public pvxs::server::OpBase
+

Manipulate an active Channel, and any in-progress Operations through it.

+
+

Public Functions

+
+
+virtual void onOp(std::function<void(std::unique_ptr<ConnectOp>&&)>&&) = 0
+

Invoked when a new GET or PUT Operation is requested through this Channel.

+
+ +
+
+virtual void onRPC(std::function<void(std::unique_ptr<ExecOp>&&, Value&&)> &&fn) = 0
+

Invoked when the peer executes an RPC.

+
+ +
+
+virtual void onSubscribe(std::function<void(std::unique_ptr<MonitorSetupOp>&&)>&&) = 0
+

Invoked when the peer create a new subscription.

+
+ +
+
+virtual void onClose(std::function<void(const std::string&)>&&) = 0
+

Callback when the channel closes (eg. peer disconnect)

+
+ +
+
+virtual void close() = 0
+

Force disconnection If called from outside a handler method, blocks until in-progress Handler methods have returned. Reference to currently attached Handler is released.

+
+ +
+
+ +
+
+struct MonitorStat
+

Information about a running monitor.

+
+

Public Members

+
+
+size_t window = 0
+

Number of available elements in the output flow window.

+
+ +
+
+size_t nQueue = 0
+

Number of un-sent updates in the local queue. Doesn’t include updates serialized and in the TX buffer.

+
+ +
+
+size_t maxQueue = 0
+

Highest value of nQueue seen

+
Since

1.1.0

+
+
+

+
+ +
+
+size_t limitQueue = 0
+

Negotiated limit on nQueue.

+
+ +
+
+size_t nSquash = 0
+

Number of updates squashed during post() calls

+
Since

1.2.0

+
+
+

+
+ +
+
+ +
+
+struct ClientCredentials
+

Credentials presented by a client.

+

Primarily a way of presenting peer address and a remote user account name. The method gives the authentication sub-protocol used and is presently one of:

+

    +

  • “ca” - Client provided account name.

    • +

  • ”anonymous” - Client provided no credentials. account will also be “anonymous”.

    • +
+

+

+
Since

0.2.0

+
+
+

+
+

Public Functions

+
+
+std::set<std::string> roles() const
+

Lookup (locally) roles associated with the account.

+

On *nix targets this is the list of primary and secondary groups in with the account is a member. On Windows targets this returns the list of local groups for the account. On other targets, an empty list is returned.

+
+ +
+
+

Public Members

+
+
+std::string peer
+

Peer address (eg. numeric IPv4)

+
+ +
+
+std::string iface
+

The local interface address (eg. numeric IPv4) through which this client is connected. May be a wildcard address (eg. 0.0.0.0) if the receiving socket is so bound.

+
+ +
+
+std::string method
+

Authentication “method”.

+
+ +
+
+std::string account
+

Remote user account name. Meaning depends upon method.

+
+ +
+
+Value raw
+

(Copy of) Credentials blob as presented by the client.

+
+ +
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/typedef.html b/typedef.html new file mode 100644 index 000000000..477a8c3e0 --- /dev/null +++ b/typedef.html @@ -0,0 +1,583 @@ + + + + + + + + + Defining Custom Types — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Defining Custom Types

+

Interface through which type definitions are created and extended for use with pvxs::Value.

+
#include <pvxs/data.h>
+namespace pvxs { ... }
+
+
+

The type system of the PVA protocol consists of a number of primitive and compound types, +as well as arrays of either. +The pvxs::TypeCode::code_t enum is an exhaustive list of all valid types, +as well as Null.

+

Any valid type may be instantiate directly.

+
Value v = TypeDef{TypeCode::String}.create();
+v = "works, but not very interesting";
+
+
+

In almost all cases, custom type definitions will be for Structures. +When defining structures, the functions of the pvxs::members namespace can help to keep definitions concise.

+
namespace M = pvxs::members;
+
+Value v = TypeDef(TypeCode::Struct, {
+    M::Int32("ifield"),
+    M::Float64("fval"),
+    M::Struct("substruct", {
+        M::String("desc"),
+    }),
+}).create();
+
+
+

It is also possible to extend definitions.

+
namespace M = pvxs::members;
+
+TypeDef def(TypeCode::Struct, {
+    M::Int32("ifield"),
+    M::Struct("substruct", {
+        M::String("desc"),
+    }),
+});
+
+def += {M::Float64("fval")};
+Value v(def.create());
+
+
+

This also applies to the ntapi allowing fields to be added. +eg. adding a string field “display.notes”.

+
namespace M = pvxs::members;
+
+TypeDef def = nt::NTScalar{TypeCode::UInt32, true}.build();
+
+def += {M::Struct("display", {M::String("notes")})};
+Value v(def.create());
+
+
+
+
+struct TypeCode
+

Possible Field types.

+

eg. String is scalar string, StringA is array of strings.

+
+

Public Types

+
+
+enum code_t
+

actual complete (scalar) type code.

+

Values:

+
+
+enumerator Bool
+
+ +
+
+enumerator BoolA
+
+ +
+
+enumerator Int8
+
+ +
+
+enumerator Int16
+
+ +
+
+enumerator Int32
+
+ +
+
+enumerator Int64
+
+ +
+
+enumerator UInt8
+
+ +
+
+enumerator UInt16
+
+ +
+
+enumerator UInt32
+
+ +
+
+enumerator UInt64
+
+ +
+
+enumerator Int8A
+
+ +
+
+enumerator Int16A
+
+ +
+
+enumerator Int32A
+
+ +
+
+enumerator Int64A
+
+ +
+
+enumerator UInt8A
+
+ +
+
+enumerator UInt16A
+
+ +
+
+enumerator UInt32A
+
+ +
+
+enumerator UInt64A
+
+ +
+
+enumerator Float32
+
+ +
+
+enumerator Float64
+
+ +
+
+enumerator Float32A
+
+ +
+
+enumerator Float64A
+
+ +
+
+enumerator String
+
+ +
+
+enumerator StringA
+
+ +
+
+enumerator Struct
+
+ +
+
+enumerator Union
+
+ +
+
+enumerator Any
+
+ +
+
+enumerator StructA
+
+ +
+
+enumerator UnionA
+
+ +
+
+enumerator AnyA
+
+ +
+
+enumerator Null
+
+ +
+ +
+
+

Public Functions

+
+
+inline uint8_t order() const
+

size()==1<<order()

+
+ +
+
+inline uint8_t size() const
+

Size in bytes for simple kinds (Bool, Integer, Real)

+
+ +
+
+inline bool isunsigned() const
+

For Integer kind.

+
+ +
+
+inline bool isarray() const
+

For all.

+
+ +
+
+inline constexpr TypeCode arrayOf() const
+

associated array of type

+
+ +
+
+inline constexpr TypeCode scalarOf() const
+

associated not array of type

+
+ +
+
+const char *name() const
+

name string. eg. “bool” or “uint8_t”

+
+ +
+
+

Public Members

+
+
+code_t code
+

the actual type code. eg. for switch()

+
+ +
+
+ +
+
+class TypeDef
+

Define a new type, either from scratch, or based on an existing Value

+

namespace M = pvxs::members;
+auto def1 = TypeDef(TypeCode::Int32); // a single scalar field
+auto def2 = TypeDef(TypeCode::Struct, {
+    M::Int32("value"),
+    M::Struct("alarm", "alarm_t", {
+        M::Int32("severity"),
+    }),
+    def1.as("special"), // compose definitions
+});
+
+auto val = def2.create(); // instantiate a Value
+});
+
+
+

+
+

Public Functions

+
+
+TypeDef() = default
+

new, empty, definition

+
+ +
+
+explicit TypeDef(const Value&)
+

pre-populate definition based on provided Value

+
+ +
+
+template<typename Iterable>
inline TypeDef(TypeCode code, const std::string &id, const Iterable &children)
+

new definition with id and children. code must be TypeCode::Struct or TypeCode::Union

+
+ +
+
+inline TypeDef(TypeCode code)
+

new definition for a single scalar field. code must not be TypeCode::Struct or TypeCode::Union

+
+ +
+
+inline TypeDef(TypeCode code, std::initializer_list<Member> children)
+

new definition without id. code must be TypeCode::Struct or TypeCode::Union

+
+ +
+
+Member as(const std::string &name) const
+

Use this definition as a member (eg. sub-structure) in another definition.

+
+ +
+
+Member as(TypeCode code, const std::string &name) const
+

Use this definition as a member (eg. sub-structure) in another definition with a (limited) type change.

+

A Kind::Compound type (eg. Struct) may be changed to another Compound type (eg. StructA). However. changes between Compound and non-Compound are not allowed.

+

+
Since

1.1.0

+
+
+

+
+ +
+
+template<typename Iterable>
inline TypeDef &operator+=(const Iterable &children)
+

append additional children. Only for TypeCode::Struct or TypeCode::Union

+
+ +
+
+Value create() const
+

Instantiate this definition.

+
+ +
+
+ +
+
+struct Member
+

Definition of a member of a Struct/Union for use with TypeDef.

+
+

Public Functions

+
+
+inline Member()
+

Empty/invalid Member.

+
+ +
+
+inline Member(TypeCode code, const std::string &name)
+

Member for non-Compound

+
+
Pre:
+

code.kind()!=Kind::Compound

+
+
+
+ +
+
+inline Member(TypeCode code, const std::string &name, const std::string &id, std::initializer_list<Member> children)
+

Compound member with type ID.

+
+ +
+
+inline Member(TypeCode code, const std::string &name, std::initializer_list<Member> children)
+

Compound member without type ID.

+
+ +
+
+ +
+
+namespace members
+

Helper functions for building TypeDef.

+

Each of the TypeCode::code_t enums has an associated helper function of the same name which is a shorthand notation for a Member().

+

eg. 

members::UInt32("blah") 
+
+
+ is equivalent to 
Member(TypeCode::UInt32, "blah") 
+
+
+

+
+ +
+
+enum class pvxs::Kind : uint8_t
+

Groups of related types.

+

Values:

+
+
+enumerator Bool
+
+ +
+
+enumerator Integer
+
+ +
+
+enumerator Real
+
+ +
+
+enumerator String
+
+ +
+
+enumerator Compound
+
+ +
+
+enumerator Null
+
+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/util.html b/util.html new file mode 100644 index 000000000..c518520b6 --- /dev/null +++ b/util.html @@ -0,0 +1,821 @@ + + + + + + + + + Misc — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Misc

+
+

Logging

+

PVXS internally logs warning/status messages using errlog.h from EPICS Base. +User applications may control which messages are printed, and may add output.

+
#include <pvxs/log.h>
+namespace pvxs { ... }
+
+
+

Control of log message output is available through named loggers. +All internal logger names begin with the prefix “pvxs.”.

+

In addition to a name, each logger has an associated integer logging level. +A message will be logged if the level of the message is less than or +equal to the level of the associated logger.

+

To enable all logging at full detail.

+
export PVXS_LOG="*=DEBUG"
+
+
+
+
+enum class pvxs::Level
+

Importance of message.

+

Values:

+
+
+enumerator Debug
+
+ +
+
+enumerator Info
+
+ +
+
+enumerator Warn
+
+ +
+
+enumerator Err
+
+ +
+
+enumerator Crit
+
+ +
+ +
+

Controlling Logging

+

By default, all loggers have level Err. +It is recommended that user applications prefer configuration +through the environment variable $PVXS_LOG by calling pvxs::logger_config_env().

+
+
+void pvxs::logger_config_env()
+

Configure logging from environment variable $PVXS_LOG

+

Value of the form “key=VAL,…”

+

Keys may be literal logger names, or may include ‘*’ wildcards to match multiple loggers. eg. “pvxs.*=DEBUG” will enable all internal log messages.

+

VAL may be one of “CRIT”, “ERR”, “WARN”, “INFO”, or “DEBUG”

+
+ +

If this is undesirable, logger levels may be (reset) manually.

+
+
+inline void pvxs::logger_level_set(const char *name, Level lvl)
+
+ +
+
+void pvxs::logger_level_clear()
+

Remove any previously logger configurations. Does not change any logger::lvl Use prior to re-applying new configuration.

+
+ +
+
+

Logging from User applications

+

To emit log messages from user code, a new logger should be defined with DEFINE_LOGGER +which will be usable within the current translation unit. +It is allowable for multiple loggers to have the same name.

+

Logger names beginning with “pvxs.*” is reserved for internal usage, +and must not be present in user code.

+
+
+DEFINE_LOGGER(VAR, NAME)
+

Define a new logger global.

+
+
Parameters:
+
    +

  • VAR – The (static) variable name passed to log_printf() and friends.

    • +

  • NAME – A name string in “A.B.C” form.

    • +
+
+
+
+ +
+
+log_crit_printf(LOGGER, FMT, ...)
+
+ +
+
+log_err_printf(LOGGER, FMT, ...)
+
+ +
+
+log_warn_printf(LOGGER, FMT, ...)
+
+ +
+
+log_info_printf(LOGGER, FMT, ...)
+
+ +
+
+log_debug_printf(LOGGER, FMT, ...)
+
+ +
+
+log_printf(LOGGER, LVL, FMT, ...)
+

Try to log a message at the defined level.

+

Due to portability issues with MSVC, log formats must have at least one argument.

+

DEFINE_LOGGER(blah, "myapp.blah");
+void blahfn(int x) {
+    log_info_printf(blah, "blah happened with %d\n", x);
+
+
+

+
+ +
+
+struct logger
+

A logger.

+
+

Public Functions

+
+
+inline bool test(Level lvl)
+
+
Returns:
+

true if the logger currently allows a message at level LVL.

+
+
+
+ +
+
+

Public Members

+
+
+const char *const name
+

global name of this logger. Need not be unique

+
+ +
+
+std::atomic<Level> lvl
+

Current logging level. See logger_level_set().

+
+ +
+
+ +
+
+
+

Identification

+

Compile time access to PVXS library version information.

+
#include <pvxs/util.h>
+namespace pvxs { ... }
+
+
+
+
+PVXS_VERSION
+

Current library version.

+
+ +
+
+PVXS_ABI_VERSION
+

Current library ABI version

+
Since

0.1.1

+
+
+

+
+ +
+
+VERSION_INT(V, R, M, P)
+

Construct version number constant.

+
+ +

eg. to conditionally compile based on library version.

+
#if PVXS_VERSION < VERSION_INT(1,2,3,4)
+// enable some compatibility code
+#endif
+
+
+
+
+unsigned long pvxs::version_int()
+
+
Returns:
+

PVXS_VERSION captured at library compile time

+
+
+
+ +
+
+const char *pvxs::version_str()
+

Library version as a string. eg. “PVXS 1.2.3”.

+
+ +
+
+unsigned long pvxs::version_abi_int()
+

+
Since

0.1.1

+
+
+

+
+
Returns:
+

PVXS_ABI_VERSION captured at library compile time

+
+
+
+ +
+
+static inline bool pvxs::version_abi_check()
+

Runtime ABI check.

+

This test is only meaningful if it is performed prior to any other library calls.

+

It is guaranteed that the library has no global constructors.

+

+
Since

0.1.1

+
+
+

+
+
Returns:
+

true if the header and library ABI versions match, and if the header version is not newer than the library version.

+
+
+
+ +
+
+

Unit-test helpers

+

Extensions to epicsUnitTest.h

+
#include <pvxs/unittest.h>
+namespace pvxs { ... }
+
+
+
+
+testTrue(EXPR)
+

Macro which assert that an expression evaluate to ‘true’. Evaluates to a pvxs::testCase

+
+ +
+
+testFalse(EXPR)
+

Macro which assert that an expression evaluate to ‘true’. Evaluates to a pvxs::testCase

+
+ +
+
+testEq(LHS, RHS)
+

Macro which asserts equality between LHS and RHS. Evaluates to a pvxs::testCase Roughly equivalent to 

testOk((LHS)==(RHS), "..."); 
+
+
+

+
+ +
+
+testNotEq(LHS, RHS)
+

Macro which asserts in-equality between LHS and RHS. Evaluates to a pvxs::testCase Roughly equivalent to 

testOk((LHS)!=(RHS), "..."); 
+
+
+

+
+ +
+
+testStrEq(LHS, RHS)
+

Macro which asserts equality between LHS and RHS. Evaluates to a pvxs::testCase Functionally equivalent to testEq() with two std::string instances. Prints diff-like output which is friendlier to multi-line strings.

+
+ +
+
+testStrMatch(EXPR, STR)
+

Macro which asserts that STR matches the regular expression EXPR Evaluates to a pvxs::testCase

+
Since

0.2.1 Expression syntax is POSIX extended.

+
+
Since

0.1.1

+
+
+

+
+ +
+
+testArrEq(LHS, RHS)
+

Macro which asserts equality between LHS and RHS. Evaluates to a pvxs::testCase Functionally equivalent to testEq() for objects with .size() and operator[]. Prints element by element differences

+
+ +
+
+testShow()
+

Macro which prints diagnostic (non-test) lines. Evaluates to a pvxs::testCase Roughly equivalent to 

testDiag("..."); 
+
+
+

+
+ +

The testEq() macro and friends expand to a function which returns a pvxs::testCase instance +which may be used as a std::ostream to append text describing a test. eg.

+
testEq(1, 1)<<"We really hope this is true.";
+if(testNotEq(1, 2)<<"shouldn't be true") {
+    // further conditional tests if 1!=2
+}
+
+
+
+
+template<class Exception, typename FN>
testCase pvxs::testThrows(FN fn)
+

Assert that an exception is thrown.

+

testThrows<std::runtime_error>([]() {
+     testShow()<<"Now you see me";
+     throw std::runtime_error("I happened");
+     testShow()<<"Now you don't";
+})<<"some message";
+
+
+

+
+
Template Parameters:
+

Exception – The exception type which should be thrown

+
+
Parameters:
+

fn – A callable

+
+
Returns:
+

A testCase which passes if an Exception instance was caught, and false otherwise (wrong type, or no exception).

+
+
+
+ +
+
+template<class Exception, typename FN>
testCase pvxs::testThrowsMatch(const std::string &expr, FN fn)
+

Assert that an exception is throw with a certain message.

+

testThrowsMatch<std::runtime_error>("happened", []() {
+     testShow()<<"Now you see me";
+     throw std::runtime_error("I happened");
+     testShow()<<"Now you don't";
+})<<"some message";
+
+
+

+

+
Since

0.1.1

+
+
+

+
+
Template Parameters:
+

Exception – The exception type which should be thrown

+
+
Parameters:
+
    +

  • expr – A regular expression

    • +

  • fn – A callable

    • +
+
+
Returns:
+

A testCase which passes if an Exception instance was caught and std::exception::what() matched the provided regular expression.

+
+
+
+ +
+
+class testCase
+

A single test case (or diagnostic line).

+

Acts as an output string to accumulate test comment. Multi-line output results in one test line, and subsequent diagnostic lines.

+

Test line is printed when an active (non-moved) testCase is destroyed.

+
+

Public Functions

+
+
+testCase()
+

new diag message

+
+ +
+
+explicit testCase(bool result)
+

new test case

+
+ +
+
+inline explicit operator bool() const
+

true when passing

+
+ +
+
+inline testCase &setPass(bool v)
+

Override current pass/fail result.

+
+ +
+
+testCase &setPassMatch(const std::string &expr, const std::string &inp)
+

Override current pass/fail result if input matches a regular expression

+
Since

0.2.1 Expression syntax is POSIX extended.

+
+
Since

0.1.1 Added

+
+
+

+
+ +
+
+template<typename T>
inline testCase &operator<<(const T &v)
+

Append to message.

+
+ +
+
+inline std::ostream &stream()
+

Access to underlying std::ostream used to accumulate notes. When our operator<< isn’t enough.

+
Since

1.1.4

+
+
+

+
+ +
+
+ +
+

IOC Testing

+

Additional helpers for testing IOC applications.

+
#include <pvxs/iochooks.h>
+namespace pvxs { namespace ioc { ... } }
+
+
+

When possible, use of the TestIOC class is recommended for both +forward and backward compatibility with EPICS Base (>= 3.15.0.1).

+
+
+class TestIOC
+

Manage Test IOC life-cycle calls.

+

Makes necessary calls to dbUnitTest.h API as well as any added calls needed by PVXS components.

+

MAIN(mytest) {
+    testPlan(0); // TODO: Set actual number of tests
+    pvxs::testSetup();
+    pvxs::logger_config_env(); // (optional)
+    {
+        TestIOC ioc; // testdbPrepare()
+
+        // mytestioc.dbd must include pvxsIoc.dbd
+        testdbReadDatabase("mytestioc.dbd", NULL, NULL);
+        mytestioc_registerRecordDeviceDriver(pdbbase);
+        testdbReadDatabase("sometest.db", NULL, NULL);
+
+        // tests before iocInit()
+
+        ioc.init();
+
+        // tests after iocInit()
+
+        ioc.shutdown(); // (optional) in ~TestIOC if omitted
+    }
+    {
+        ... repeat ...
+    }
+    epicsExitCallAtExits();
+    pvxs::cleanup_for_valgrind();
+}
+
+
+

+

+
Since

1.3.0

+
+
+

+
+ +
+
+
+

Utilities

+

Misc. utility code.

+
#include <pvxs/util.h>
+namespace pvxs { ... }
+
+
+
+
+inline detail::Escaper pvxs::escape(const std::string &s)
+

Print string to output stream with non-printable characters escaped.

+

Outputs (almost) C-style escapes. Prefers short escapes for newline, tab, quote, etc (”\n”). Falls back to hex escape (eg. “\xab”).

+

Unlike C, hex escapes are always 2 chars. eg. the output “\xabcase” would need to be manually changed to “\xab””case” to be used as C source.

+

std::string blah("this \"is a test\"");
+std::cout<<pvxs::escape(blah);
+
+
+

+
+ +
+
+inline detail::Escaper pvxs::escape(const char *s)
+

Print nil terminated char array to output stream with non-printable characters escaped. 

std::cout<<pvxs::escape("this \"is a test\"");
+
+
+

+
+ +
+
+inline detail::Escaper pvxs::escape(const char *s, size_t n)
+

Print fixed length char array to output stream with non-printable characters escaped. 

std::cout<<pvxs::escape("this \"is a test\"", 6);
+// prints 'this \"'
+
+
+

+
+ +
+
+void pvxs::cleanup_for_valgrind()
+

Free some internal global allocations to avoid false positives in valgrind (or similar) tools looking for memory leaks.

+

Calls libevent_global_shutdown() when available (libevent >=2.1).

+
+

Warning

+

This function is optional. If you don’t understand the intended use case, then do not call it!

+
+
+
Pre:
+

Caller must release all resources explicitly allocated through PVXS (on all threads).

+
+
Post:
+

Invalidates internal state. Use of any API functions afterwards is undefined!

+
+
+
+ +
+
+class SigInt
+

Portable process signal handling in CLI tools.

+

epicsEvent evt;
+SigInt handle([&evt]() {
+     evt.trigger();
+});
+... setup network operations
+evt.wait();
+// completion, or SIGINT
+
+
+

+

Saves existing handler, which are restored by dtor.

+

+
Since

1.1.0 “handler” action runs in thread context. Safe to take locks etc. Previously handler action ran in signal handler context.

+
+
+

+
+ +
+
+std::ostream &pvxs::target_information(std::ostream&)
+

Describe build and runtime configuration of current system.

+

Print information which may be using for when troubleshooting, or creating a bug report.

+

Printed by CLI “pvxinfo -D” and iocsh “pvxs_target_information”.

+
+
Returns:
+

The same ostream passed as argument.

+
+
+
+ +
+
+template<typename T>
class MPMCFIFO
+

Thread-safe, bounded, multi-producer, multi-consumer FIFO queue.

+

Queue value_type must be movable. If T is also copy constructable, then push(const T&) may be used.

+

As an exception, the destructor is not re-entrant. Concurrent calls to methods during destruction will result in undefined behavior.

+

MPMCFIFO<std::function<void()>> Q;
+...
+while(auto work = Q.pop()) { // Q.push(nullptr) to break loop
+    work();
+}
+
+
+

+

+
Since

0.2.0

+
+
+

+
+

Public Types

+
+
+typedef T value_type
+

Template parameter.

+
+ +
+
+

Public Functions

+
+
+inline explicit MPMCFIFO(size_t limit = 0u)
+

Construct a new queue

+
+
Parameters:
+

limit – If non-zero, then emplace()/push() will block while while queue size is greater than or equal to this limit.

+
+
+
+ +
+
+inline ~MPMCFIFO()
+

Destructor is not re-entrant.

+
+ +
+
+inline size_t size() const
+

Poll number of elements in the work queue at this moment.

+
+ +
+
+template<typename ...Args>
inline void emplace(Args&&... args)
+

Construct a new element into the queue.

+

Will block while full.

+
+ +
+
+inline void push(T &&ent)
+

Move a new element to the queue.

+
+ +
+
+inline void push(const T &ent)
+

Copy a new element to the queue.

+
+ +
+
+inline T pop()
+

Remove an element from the queue.

+

Blocks while queue is empty.

+
+ +
+
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/value.html b/value.html new file mode 100644 index 000000000..bfc96bc9d --- /dev/null +++ b/value.html @@ -0,0 +1,1043 @@ + + + + + + + + + Value Container API — PVXS 1.3.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Value Container API

+
+

Contents:

+ +
+
#include <pvxs/data.h>
+namespace pvxs { ... }
+
+
+

pvxs::Value is the primary data container type used with PVXS. +A pvxs::Value may be obtained via the remote peer (client or server), +or created locally. See ntapi or typedefapi.

+

pvxs::Value is a safe pointer-like object which, maybe, references +a node in a tree of sub-structures and leaf fields. +This tree will be referred to as a Structure as it behaves +in many ways like a C ‘struct’.

+

For example, the following code:

+
Value top = TypeDef(TypeCode::Struct, {
+    members::Int32("fldname"),
+}).create();
+
+top["fldname"] = 1;
+
+fld = top["fldname"];
+fld = 2;
+
+
+

Is analogous to the following pseudo code.

+
// pseudo-code
+struct anon {
+    int32_t fldname=0u;
+};
+void* top = new anon;
+
+static_cast<anon*>(top)->fldname = 1;
+
+void* fld = &static_cast<anon*>(top)->fldname;
+static_cast<int32_t*>(fld) = 2;
+
+
+

With the chief functional difference being that the analogs of the casts are made safe. +Also, the storage of the underlying Structure will be free’d when no more Values reference it.

+

A Value which does not reference any underlying Structure is not valid, or “empty”.

+
Value dummy;
+assert(!dummy.valid());
+assert(!dummy); // operator bool() is an alias for valid()
+
+
+

An invalid Value may be returned on error by some methods. +All operations on an invalid Value should be safe and well defined.

+
Value top(nt::NTScalar{TypeCode::Int32}.create());
+int32_t val = top["nonexistent"].as<int32_t>();
+
+
+

In this example, the operator[] lookup of a non-existent field returns an invalid Value. +Attempting to extract an integer from this will then throw a pvxs::NoField exception.

+
+

Value

+
+

Field Lookup

+

Access to members of structured types is accomplished through pvxs::Value::operator[]() or pvxs::Value::lookup(). +These two methods differ in how errors are communicated. +operator[] will return an “invalid” or “empty” Value if the expression does not address a member. +lookup() will throw an exception describing where and how expression evaluation failed.

+
+
+

Iteration

+

pvxs::Value instances pointing to a non-array structured data field (Struct or Union) +may be iterated. Iteration comes in three variations: pvxs::Value::iall(), pvxs::Value::ichildren(), +and pvxs::Value::imarked().

+

For a Struct, iall() is a depth first traversal of all fields. +ichildren() traverses all child fields (excluding eg. grandchildren +and further). imarked() considers all fields, but only visits +those which have beem marked (pvxs::Value::isMarked()).

+

For a Union. iall() and ichildren() are identical, and will +visit all possible Union members, excluding the implicit NULL member. +Traversal does not effect member selection. +imarked() for a Union will visit at most one member (if one is selected)>

+

Iteration of Union may return Value instances +allocated with temporary storage. Changes to these instances +will not effect the underlying structure.

+

Iteration of other field types, including StructA and UnionA is not implemented at this time, +and will always appear as empty.

+
+
+class Value
+

Generic data container

+

References a single data field, which may be free-standing (eg. “int x = 5;”) or a member of an enclosing Struct, or an element in an array of Struct.

+

    +

  • Use valid() (or operator bool() ) to determine if pointed to a valid field.

    • +

  • Use operator[] to traverse within a Kind::Compound field.

    • +
+

+

Value val = nt::NTScalar{TypeCode::Int32}.create();
+val["value"] = 42;
+Value alias = val;
+assert(alias["value"].as<int32_t>()==42); // 'alias' is a second reference to the same Struct
+
+
+

+
+

Public Functions

+
+
+inline constexpr Value()
+

default empty Value

+
+ +
+
+Value cloneEmpty() const
+

allocate new storage, with default values

+
+ +
+
+Value clone() const
+

allocate new storage and copy in our values

+
+ +
+
+Value &assign(const Value &o)
+

copy value(s) from other. Acts like from(o) for kind==Kind::Compound . Acts like from(o.as<T>()) for kind!=Kind::Compound

+
+ +
+
+Value allocMember()
+

Use to allocate members for an array of Struct and array of Union.

+
+ +
+
+void clear()
+

Restore to newly allocated state.

+

Free any allocation for array or string values, zero numeric values. unmark() all fields.

+

+
Since

1.1.0

+
+
+

+
+ +
+
+inline bool valid() const
+

Does this Value actually reference some underlying storage.

+
+ +
+
+bool isMarked(bool parents = true, bool children = false) const
+

Test if this field is marked as valid/changed.

+
+ +
+
+Value ifMarked(bool parents = true, bool children = false) const
+

return *this if isMarked()==true, or a !valid() ref. if false.

+
+ +
+
+void mark(bool v = true)
+

Mark this field as valid/changed.

+
+ +
+
+void unmark(bool parents = false, bool children = true)
+

Remove mark from this field, and optionally parent and/or child fields.

+
Since

1.1.3 Correctly unmark parent fields

+
+
+

+
+ +
+
+TypeCode type() const
+

Type of the referenced field (or Null)

+
+ +
+
+StoreType storageType() const
+

Type of value stored in referenced field.

+
+ +
+
+const std::string &id() const
+

Type ID string (Struct or Union only)

+
+ +
+
+bool idStartsWith(const std::string &prefix) const
+

Test prefix of Type ID string (Struct or Union only)

+
+ +
+
+inline bool equalInst(const Value &o) const
+

Test for instance equality. aka. this==this.

+
+ +
+
+inline bool equalType(const Value &o) const
+

Test for equality of type only (including field names)

+
+ +
+
+const std::string &nameOf(const Value &descendant) const
+

Return our name for a descendant field. 

Value v = ...;
+assert(v.nameOf(v["some.field"])=="some.field");
+
+
+

+
+
Throws:
+
    +

  • NoField – unless both this and descendant are valid()

    • +

  • std::logic_error – if descendant is not actually a descendant

    • +
+
+
+
+ +
+
+template<typename T>
inline T as() const
+

Extract from field.

+

Type ‘T’ may be one of:

    +

  • bool

    • +

  • uint8_t, uint16_t, uint32_t, uint64_t

    • +

  • int8_t, int16_t, int32_t, int64_t

    • +

  • float, double

    • +

  • std::string

    • +

  • Value

    • +

  • shared_array<const void>

    • +

  • An enum where the underlying type is one of the preceding (since 0.2.0).

    • +
+

+
+
Throws:
+
+
+
+
+ +
+
+template<typename T>
inline bool as(T &val) const
+

Attempt to extract value from field.

+
+
Returns:
+

false if as<T>() would throw NoField or NoConvert

+
+
+
+ +
+
+template<typename T, typename FN>
inline impl::StorageMap<typenamestd::decay<FN>::type>::not_storable as(FN &&fn) const
+

Attempt to extract value from field. If possible, this value is cast to T and passed as the only argument of the provided function.

+
+ +
+
+template<typename T>
inline bool tryFrom(const T &val)
+

Attempt to assign to field.

+
+
Returns:
+

false if from<T>() would throw NoField or NoConvert

+
+
+
+ +
+
+template<typename T>
inline void from(const T &val)
+

Assign from field.

+

Type ‘T’ may be one of:

    +

  • bool

    • +

  • uint8_t, uint16_t, uint32_t, uint64_t

    • +

  • int8_t, int16_t, int32_t, int64_t

    • +

  • float, double

    • +

  • std::string

    • +

  • Value

    • +

  • shared_array<const void>

    • +

  • An enum where the underlying type is one of the preceding (since 0.2.0).

    • +
+

+
+ +
+
+template<typename T, typename K>
inline Value &update(K key, const T &val)
+

Inline assignment of sub-field. Shorthand for 

(*this)[key].from(val) 
+
+
+

+
+ +
+
+template<typename T>
inline Value &operator=(const T &val)
+

shorthand for from<T>(const T&) except for T=Value (would be ambiguous with ref. assignment)

+
+ +
+
+Value operator[](const std::string &name)
+

Attempt to access a descendant field.

+

Argument may be:

    +

  • name of a child field. eg. “value”

    • +

  • name of a descendant field. eg “alarm.severity”

    • +

  • element of an array of structures. eg “dimension[0]”

    • +

  • name of a union field. eg. “->booleanValue”

    • +
+

+

These may be composed. eg.

+

    +

  • “dimension[0]size”

    • +

  • ”value->booleanValue”

    • +
+

+
+
Returns:
+

A valid() Value if the descendant field exists, otherwise an invalid Value.

+
+
+
+ +
+
+Value lookup(const std::string &name)
+

Attempt to access a descendant field, or throw exception.

+

Acts like operator[] on success, but throws a (hopefully descriptive) exception instead of returning an invalid Value.

+

+
Since

1.1.2 An empty Value correctly throws NoField instead of returning an empty Value

+
+
+

+
+
Throws:
+
+
+
+
+ +
+
+size_t nmembers() const
+

Number of child fields. only Struct, StructA, Union, UnionA return non-zero

+
Since

1.1.3 correctly return non-zero for StructA and UnionA

+
+
+

+
+ +
+
+inline IAll iall() const noexcept
+

Depth-first iteration of all descendant fields

+

Value top(...);
+for(auto fld : top.iall()) {
+    std::cout<<top.nameOf(fld)<<" = "<<fld<<"\n";
+}
+
+
+

+
+ +
+
+inline IChildren ichildren() const noexcept
+

iteration of all child fields

+
+ +
+
+inline IMarked imarked() const noexcept
+

Depth-first iteration of all marked descendant fields.

+
+ +
+
+inline Fmt format() const
+

Configurable printing via std::ostream

+

Value val;
+std::cout<<val.format().arrayLimit(10);
+
+
+

+
+ +
+
+
+struct _IAll
+
+ +
+
+struct _IChildren
+
+ +
+
+struct _IMarked
+
+ +
+
+struct Fmt
+

Provides options to control printing of a Value via std::ostream.

+
+

Public Functions

+
+
+inline Fmt &tree()
+

Show Value in tree/struct format.

+
+ +
+
+inline Fmt &delta()
+

Show Value in delta format.

+
+ +
+
+inline Fmt &format(format_t f)
+

Explicitly select format_t.

+
+ +
+
+inline Fmt &showValue(bool v)
+

Whether to show field values, or only type information.

+
+ +
+
+inline Fmt &arrayLimit(size_t cnt)
+

When non-zero, arrays output will be truncated with “…” after cnt elements.

+
+ +
+
+ +
+
+template<typename T>
struct Iterable
+
+ +
+ +
+
+struct NoField : public std::runtime_error
+

Thrown when accessing a Null Value.

+
+ +
+
+struct NoConvert : public std::runtime_error
+

Thrown when a Value can not be converted to the requested type.

+
+ +
+
+struct LookupError : public std::runtime_error
+
+ +
+
+
+

Array fields

+

Array fields are represented with the pvxs::shared_array container +using void vs. non-void, and const vs. non-const element types.

+

Arrays are initially created as non-const and non-void. +After being populated, an array must be transformed using +pvxs::shared_array::freeze() to become const before +being stored in a pvxs::Value.

+
shared_array<double> arr({1.0, 2.0});
+Value top = nt::NTScalar{TypeCode::Float64A}.create();
+
+top["value"] = arr.freeze();
+# freeze() acts like std::move().  arr is now empty
+# only the read-only reference remains!
+
+
+

The pvxs::shared_array::freeze() method is special in that it +acts like std::move() in that it moves the array reference into the returned object. +freeze() requires exclusive ownership of the reference being frozen. +An exception will be thrown unless pvxs::shared_array::unique() would return true.

+

Array values may be extracted from pvxs::Value as either const void or const non-void. +The const non-void option is a convenience which may allocate and do an element by element conversion.

+
# extract reference, or converted copy
+arr = top["value"].as<shared_array<const double>>();
+
+
+

When it is desirable to avoid an implicit allocate and convert, +an array can be extracted as “const void”. +This does require calling pvxs::shared_array::original_type() to find the pvxs::ArrayType +of the underlying array prior to using pvxs::shared_array::castTo().

+
# extract untyped reference.  Never copies
+shared_array<const void> varr = top["value"].as<shared_array<const void>>();
+if(varr.original_type()==ArrayType::Float64) {
+    # castTo() throws std::logic_error if the underlying type is not 'double'.
+    shared_array<const double> temp = varr.castTo<const double>();
+}
+
+
+
+
+template<typename E, class Enable>
class shared_array : public pvxs::detail::sa_base<E>
+

std::vector-like contiguous array of items passed by reference.

+

shared_array comes in const and non-const, as well as void and non-void variants.

+

A non-const array is allocated and filled, then last non-const reference is exchanged for new const reference. This const reference can then be safely shared between various threads.

+

shared_array<uint32_t> arr({1, 2, 3});
+assert(arr.size()==3);
+shared_ptr<const uint32_t> constarr(arr.freeze());
+assert(arr.size()==0);
+assert(constarr.size()==3);
+
+
+

+

The void / non-void variants allow arrays to be moved without explicit typing. However, the void variant preserves the original ArrayType.

+

shared_array<uint32_t> arr({1, 2, 3});
+assert(arr.size()==3);
+shared_array<void> voidarr(arr.castTo<void>());
+assert(arr.size()==0);
+assert(voidarr.size()==3); // void size() in elements
+
+
+

+
+

Public Functions

+
+
+template<typename A>
inline shared_array(std::initializer_list<A> L)
+

allocate new array and populate from initializer list

+
+ +
+
+template<typename Iter, typename std::iterator_traits<Iter>::difference_type = 0>
inline shared_array(Iter begin, Iter end)
+

Construct a copy of another a sequence. Requires random access iterators.

+
+ +
+
+inline explicit shared_array(size_t c)
+

Allocate (with new[]) a new vector of size c.

+
+ +
+
+template<typename V>
inline shared_array(size_t c, V e)
+

Allocate (with new[]) a new vector of size c and fill with value e.

+
+ +
+
+inline shared_array(E *a, size_t len)
+

use existing alloc with delete[]

+
+ +
+
+template<typename B>
inline shared_array(E *a, B b, size_t len)
+

use existing alloc w/ custom deletor

+
+ +
+
+inline shared_array(const std::shared_ptr<E> &a, size_t len)
+

build around existing shared_ptr

+
+ +
+
+template<typename A>
inline shared_array(const std::shared_ptr<A> &a, E *b, size_t len)
+

alias existing shared_array

+
+ +
+
+size_t size() const
+

Number of elements.

+
+ +
+
+bool empty() const
+

size()==0

+
+ +
+
+bool unique() const
+

True if this instance is the only (strong) reference.

+
+ +
+
+void clear()
+

Reset size()==0.

+
+ +
+
+void swap(shared_array &o)
+

Exchange contents with other.

+
+ +
+
+E *data() const noexcept
+

Access to raw pointer. May be nullptr if size()==0

+
+ +
+
+inline void resize(size_t i)
+

Extend size. Implies make_unique().

+
+
Post:
+

unique()==true

+
+
+
+ +
+
+inline void make_unique()
+

Ensure exclusive ownership of array data by making a copy if necessary.

+
+
Post:
+

unique()==true

+
+
+
+ +
+
+inline iterator begin() const noexcept
+

begin iteration

+
+ +
+
+inline iterator end() const noexcept
+

end iteration

+
+ +
+
+inline reference operator[](size_t i) const noexcept
+

Member access Use sa.data() instead of &sa[0].

+
+
Pre:
+

!empty() && i<size()

+
+
+
+ +
+
+inline reference at(size_t i) const
+

Member access.

+
+
Throws:
+

std::out_of_range – if empty() || i>=size().

+
+
+
+ +
+
+inline shared_array<typename std::add_const<E>::type> freeze()
+

Cast to const, consuming this

+
+
Throws:
+

std::logic_error – if !unique()

+
+
Pre:
+

unique()==true

+
+
Post:
+

empty()==true

+
+
+
+ +
+
+inline shared_array<typename std::remove_const<E>::type> thaw()
+

Return non-const (maybe) copy. consuming this

+

If

+unique(), transforms this reference into the returned const reference. If not unique(), returns a copy and clears this reference. In either case, the returned reference will be unique().
+
Since

1.1.2

+
+
+

+
+
Post:
+

empty()==true

+
+
+
+ +
+
+template<typename TO>
shared_array<TO> castTo() const
+

Cast to/from void, preserving const-ness.

+

A “safe” version of static_cast<>()

+

Allowed casts depend upon two aspects of type parameter E.

+

Whether the base type is void or non-void. And whether or not the const qualifier is present.

+

Type E may always be cast to itself.

+

Casts must preserve const-ness. Either both of E and TO, or neither, must be const qualified.

+

At most one of E or TO may have different non-void base type.

+
+
Throws:
+

std::logic_error – on void -> non-void cast when requested type and the original_type() do not match.

+
+
+
+ +
+
+template<typename TO>
shared_array<TO> convertTo() const
+

Cast with fallback to copy. Preserves const-ness

+

Return either a reference or a copy of this array. A copy will be made if the requested type and the original_type() do not match. Otherwise functions like castTo().

+
+ +
+
+inline detail::Limiter format() const
+

Provide options when rendering with std::ostream.

+

shared_array<int32_t> arr({1,2,3,4});
+// print entire array
+//   {4}[1,2,3,4]
+std::cout<<arr;
+// print at most 3 elements
+//   {4}[1,2,3,...]
+std::cout<<arr.format().limit(3);
+
+
+

+
+ +
+
+inline ArrayType original_type() const
+

return type of underlying array. (void only)

+
+ +
+
+ +
+
+size_t pvxs::elementSize(ArrayType type)
+

Return storage size (aka. sizeof() ) for array element type

+
+
Throws:
+

std::logic_error – for invalid types.

+
+
+
+ +
+
+class Limiter
+

Provide options when rendering with std::ostream.

+
+

Public Functions

+
+
+inline Limiter &limit(size_t l)
+

Maximum number of array elements to print. “…” is printed in place of any further elements.

+
+ +
+
+ +
+
+enum class pvxs::ArrayType : uint8_t
+

Identify real array type in void specializations of shared_array.

+

See also

+

shared_array::original_type()

+
+

+

Values:

+
+
+enumerator Null
+

Untyped.

+
+ +
+
+enumerator Bool
+

bool

+
+ +
+
+enumerator Int8
+

int8_t

+
+ +
+
+enumerator Int16
+

int16_t

+
+ +
+
+enumerator Int32
+

int32_t

+
+ +
+
+enumerator Int64
+

int64_t

+
+ +
+
+enumerator UInt8
+

uint8_t

+
+ +
+
+enumerator UInt16
+

uint16_t

+
+ +
+
+enumerator UInt32
+

uint32_t

+
+ +
+
+enumerator UInt64
+

uint64_t

+
+ +
+
+enumerator Float32
+

float

+
+ +
+
+enumerator Float64
+

double

+
+ +
+
+enumerator String
+

std::string

+
+ +
+
+enumerator Value
+

Value.

+
+ +
+ +
+
+ + +
+ +
+
+ +
+
+
+ ©2024 Michael Davidsaver and Osprey DCS LLC. + + | + Powered by Sphinx 5.3.0 + & Alabaster 0.7.12 + + | + Page source +
+ + + + + + \ No newline at end of file