gcdevproxy
| Crates.io | gcdevproxy |
| lib.rs | gcdevproxy |
| version | 0.3.0 |
| source | src |
| created_at | 2022-11-23 15:33:30.000864 |
| updated_at | 2024-02-14 16:25:28.767719 |
| description | GoodCam Device Proxy library |
| homepage | |
| repository | https://github.com/GoodCam/device-proxy-lib |
| max_upload_size | |
| id | 721712 |
| size | 221,577 |
Ondřej Perutka (operutka)
documentation
README
GoodCam Device Proxy
This library simplifies creating HTTP proxies that can be used to communicate with GoodCam devices in various networks. GoodCam devices contain a built-in client that can be configured to connect automatically to a given proxy. Once connected, the devices will wait for incoming HTTP requests. The proxy simply forwards incoming HTTP requests to the connected devices.
Dependencies
The library requires OpenSSL (version 1.0.1 or newer) or LibreSSL (version 2.5 or newer). Ubuntu/Debian users can install OpenSSL development files using:
sudo apt-get install libssl-dev
Fedora users can install them using:
sudo dnf install openssl-devel
Usage example
See the examples directory in the root of this repository for a ready-to-use
example.
use gcdevproxy::{
async_trait::async_trait,
auth::BasicAuthorization,
http::{Body, Request},
ClientHandlerResult, DeviceHandlerResult, Error, RequestHandler,
};
struct MyRequestHandler;
#[async_trait]
impl RequestHandler for MyRequestHandler {
async fn handle_device_request(
&self,
authorization: BasicAuthorization,
) -> Result<DeviceHandlerResult, Error> {
...
}
async fn handle_client_request(
&self,
request: Request<Body>,
) -> Result<ClientHandlerResult, Error> {
...
}
}
let mut builder = ProxyBuilder::new();
builder
.hostname(hostname)
.http_bind_address(SocketAddr::from((Ipv4Addr::UNSPECIFIED, 8080)));
builder
.build(MyRequestHandler)
.await
.unwrap()
.await
.unwrap();
Bindings to other languages
The library provides a C API which can be used also in other programming
languages. See the include folder in the root of the repository for more
details. Currently we also provide wrapper libraries for: