2013-08-18 21:49:12 -07:00
|
|
|
.. _api:
|
|
|
|
|
|
|
|
|
|
API Reference
|
|
|
|
|
===================
|
2013-08-18 22:43:40 -07:00
|
|
|
|
|
|
|
|
.. automodule:: capnp
|
|
|
|
|
|
|
|
|
|
.. currentmodule:: capnp
|
|
|
|
|
|
2013-08-26 16:16:58 -07:00
|
|
|
Internal Classes
|
|
|
|
|
----------------
|
|
|
|
|
These classes are internal to the library. You will never need to allocate
|
|
|
|
|
one yourself, but you may end up using some of their member methods.
|
|
|
|
|
|
2013-11-14 20:59:21 -08:00
|
|
|
Modules
|
|
|
|
|
~~~~~~~~~~
|
|
|
|
|
These are classes that are made for you when you import a Cap'n Proto file::
|
|
|
|
|
|
|
|
|
|
import capnp
|
|
|
|
|
import addressbook_capnp
|
|
|
|
|
|
|
|
|
|
print type(addressbook_capnp.Person) # capnp.capnp._StructModule
|
|
|
|
|
|
|
|
|
|
.. autoclass:: _StructModule
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: _InterfaceModule
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
2013-08-26 16:16:58 -07:00
|
|
|
Readers
|
|
|
|
|
~~~~~~~~~~
|
|
|
|
|
.. autoclass:: _DynamicStructReader
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: _DynamicListReader
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
Builders
|
|
|
|
|
~~~~~~~~~~
|
|
|
|
|
.. autoclass:: _DynamicStructBuilder
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: _DynamicListBuilder
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
2013-08-29 18:46:17 -07:00
|
|
|
|
|
|
|
|
.. autoclass:: _DynamicResizableListBuilder
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
2013-08-26 22:00:12 -07:00
|
|
|
|
2013-11-14 20:59:21 -08:00
|
|
|
RPC
|
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. autoclass:: _DynamicCapabilityClient
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. autoclass:: _CapabilityClient
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
2013-08-26 22:00:12 -07:00
|
|
|
Miscellaneous
|
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
.. autoclass:: _DynamicOrphan
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
2013-11-14 20:59:21 -08:00
|
|
|
|
2013-12-12 00:02:44 -08:00
|
|
|
.. autoclass:: KjException
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
2013-11-14 20:59:21 -08:00
|
|
|
Functions
|
|
|
|
|
-------------
|
|
|
|
|
.. autofunction:: load
|
|
|
|
|
.. autofunction:: add_import_hook
|
|
|
|
|
.. autofunction:: remove_import_hook
|
2013-12-12 00:02:44 -08:00
|
|
|
.. autofunction:: join_promises
|
2013-11-14 20:59:21 -08:00
|
|
|
|
|
|
|
|
Classes
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
RPC
|
|
|
|
|
~~~~~~~~~~~~~~~
|
2013-12-12 00:02:44 -08:00
|
|
|
.. autoclass:: TwoPartyClient
|
2013-11-14 20:59:21 -08:00
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
2013-12-12 00:02:44 -08:00
|
|
|
.. autoclass:: TwoPartyServer
|
2013-11-14 20:59:21 -08:00
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
2013-12-12 00:02:44 -08:00
|
|
|
.. autoclass:: Promise
|
2013-11-14 20:59:21 -08:00
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
.. autoclass:: PromiseFulfillerPair
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
Miscellaneous
|
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
.. autoclass:: SchemaParser
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
:inherited-members:
|
|
|
|
|
|
|
|
|
|
|
