core-extra/docs/grpc.md

# Using the gRPC API

[gRPC](https://grpc.io/) is the main API for interfacing with CORE and used by
the python GUI for driving all functionality.

Currently we are providing a python client that wraps the generated files for
leveraging the API, but proto files noted below can also be leveraged to generate
bindings for other languages as well.

## HTTP Proxy

Since gRPC is HTTP2 based, proxy configurations can cause issue. You can either
properly account for this issue or clear out your proxy when running if needed.

## Python Client

A python client wrapper is provided at
[CoreGrpcClient](https://github.com/coreemu/core/blob/master/daemon/core/api/grpc/client.py)
to help provide some conveniences when using the API.

## Proto Files

Proto files are used to define the API and protobuf messages that are used for
interfaces with this API.

They can be found
[here](https://github.com/coreemu/core/tree/master/daemon/proto/core/api/grpc)
to see the specifics of
what is going on and response message values that would be returned.

## Examples

Example usage of this API can be found
[here](https://github.com/coreemu/core/tree/master/daemon/examples/grpc).
These examples will create a session using the gRPC API when the core-daemon is running.

You can then switch to and attach to these sessions using either of the CORE GUIs.
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00			`# Using the gRPC API`

grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`[gRPC](https://grpc.io/) is the main API for interfacing with CORE and used by`
			`the python GUI for driving all functionality.`

			`Currently we are providing a python client that wraps the generated files for`
			`leveraging the API, but proto files noted below can also be leveraged to generate`
			`bindings for other languages as well.`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
small update to grpc docs 2019-10-19 05:51:15 +01:00			`## HTTP Proxy`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`Since gRPC is HTTP2 based, proxy configurations can cause issue. You can either`
			`properly account for this issue or clear out your proxy when running if needed.`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
			`## Python Client`

grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`A python client wrapper is provided at`
fix bad links in generated docs for grpc to point to latest on master 2020-07-16 01:09:32 +01:00			`[CoreGrpcClient](https://github.com/coreemu/core/blob/master/daemon/core/api/grpc/client.py)`
			`to help provide some conveniences when using the API.`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`## Proto Files`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`Proto files are used to define the API and protobuf messages that are used for`
			`interfaces with this API.`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
fix bad links in generated docs for grpc to point to latest on master 2020-07-16 01:09:32 +01:00			`They can be found`
			`[here](https://github.com/coreemu/core/tree/master/daemon/proto/core/api/grpc)`
			`to see the specifics of`
grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`what is going on and response message values that would be returned.`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`## Examples`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
fix bad links in generated docs for grpc to point to latest on master 2020-07-16 01:09:32 +01:00			`Example usage of this API can be found`
			`[here](https://github.com/coreemu/core/tree/master/daemon/examples/grpc).`
			`These examples will create a session using the gRPC API when the core-daemon is running.`
small tweaks to documentation, initial add of a section for grpc, moved ns3 to experimental section 2019-06-11 20:05:04 +01:00
grpc doc improvements, grpc examples additions, small tweak to grpc client for setting emane models not requiring a config when using default configuration 2020-06-05 19:20:23 +01:00			`You can then switch to and attach to these sessions using either of the CORE GUIs.`