1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
use std::{collections::HashMap, sync::Arc};
use karyon_core::async_runtime::Executor;
#[cfg(feature = "tcp")]
use karyon_net::Endpoint;
use karyon_net::ToEndpoint;
#[cfg(feature = "tls")]
use karyon_net::async_rustls::rustls;
#[cfg(feature = "tcp")]
use crate::{Error, TcpConfig};
use crate::{PubSubRPCService, RPCService, Result};
use super::{Server, ServerConfig};
/// Builder for constructing an RPC [`Server`].
pub struct ServerBuilder {
inner: ServerConfig,
}
impl ServerBuilder {
/// Adds a new RPC service to the server.
///
/// # Example
/// ```
/// use std::sync::Arc;
///
/// use serde_json::Value;
///
/// use karyon_jsonrpc::{Server, rpc_impl, RPCError};
///
/// struct Ping {}
///
/// #[rpc_impl]
/// impl Ping {
/// async fn ping(&self, _params: Value) -> Result<Value, RPCError> {
/// Ok(serde_json::json!("Pong"))
/// }
/// }
///
/// async {
/// let server = Server::builder("ws://127.0.0.1:3000")
/// .expect("Create a new server builder")
/// .service(Arc::new(Ping{}))
/// .build().await
/// .expect("Build the server");
/// };
///
/// ```
pub fn service(mut self, service: Arc<dyn RPCService>) -> Self {
self.inner.services.insert(service.name(), service);
self
}
/// Adds a new PubSub RPC service to the server.
///
/// # Example
/// ```
/// use std::sync::Arc;
///
/// use serde_json::Value;
///
/// use karyon_jsonrpc::{
/// Server, rpc_impl, rpc_pubsub_impl, RPCError, Channel, SubscriptionID,
/// };
///
/// struct Ping {}
///
/// #[rpc_impl]
/// impl Ping {
/// async fn ping(&self, _params: Value) -> Result<Value, RPCError> {
/// Ok(serde_json::json!("Pong"))
/// }
/// }
///
/// #[rpc_pubsub_impl]
/// impl Ping {
/// async fn log_subscribe(
/// &self,
/// chan: Arc<Channel>,
/// method: String,
/// _params: Value,
/// ) -> Result<Value, RPCError> {
/// let sub = chan.new_subscription(&method).await;
/// let sub_id = sub.id.clone();
/// Ok(serde_json::json!(sub_id))
/// }
///
/// async fn log_unsubscribe(
/// &self,
/// chan: Arc<Channel>,
/// _method: String,
/// params: Value,
/// ) -> Result<Value, RPCError> {
/// let sub_id: SubscriptionID = serde_json::from_value(params)?;
/// chan.remove_subscription(&sub_id).await;
/// Ok(serde_json::json!(true))
/// }
/// }
///
/// async {
/// let ping_service = Arc::new(Ping{});
/// let server = Server::builder("ws://127.0.0.1:3000")
/// .expect("Create a new server builder")
/// .service(ping_service.clone())
/// .pubsub_service(ping_service)
/// .build().await
/// .expect("Build the server");
/// };
///
/// ```
pub fn pubsub_service(mut self, service: Arc<dyn PubSubRPCService>) -> Self {
self.inner.pubsub_services.insert(service.name(), service);
self
}
/// Configure TCP settings for the server.
///
/// # Example
///
/// ```
/// use karyon_jsonrpc::{Server, TcpConfig};
///
/// async {
/// let tcp_config = TcpConfig::default();
/// let server = Server::builder("ws://127.0.0.1:3000")
/// .expect("Create a new server builder")
/// .tcp_config(tcp_config)
/// .expect("Add tcp config")
/// .build().await
/// .expect("Build the server");
/// };
/// ```
///
/// This function will return an error if the endpoint does not support TCP protocols.
#[cfg(feature = "tcp")]
pub fn tcp_config(mut self, config: TcpConfig) -> Result<ServerBuilder> {
match self.inner.endpoint {
Endpoint::Tcp(..) | Endpoint::Tls(..) | Endpoint::Ws(..) | Endpoint::Wss(..) => {
self.inner.tcp_config = config;
Ok(self)
}
_ => Err(Error::UnsupportedProtocol(self.inner.endpoint.to_string())),
}
}
/// Configure TLS settings for the server.
///
/// # Example
///
/// ```ignore
/// use karon_jsonrpc::Server;
/// use futures_rustls::rustls;
///
/// async {
/// let tls_config = rustls::ServerConfig::new(...);
/// let server = Server::builder("ws://127.0.0.1:3000")
/// .expect("Create a new server builder")
/// .tls_config(tls_config)
/// .expect("Add tls config")
/// .build().await
/// .expect("Build the server");
/// };
/// ```
///
/// This function will return an error if the endpoint does not support TLS protocols.
#[cfg(feature = "tls")]
pub fn tls_config(mut self, config: rustls::ServerConfig) -> Result<ServerBuilder> {
match self.inner.endpoint {
Endpoint::Tls(..) | Endpoint::Wss(..) => {
self.inner.tls_config = Some(config);
Ok(self)
}
_ => Err(Error::UnsupportedProtocol(format!(
"Invalid tls config for endpoint: {}",
self.inner.endpoint
))),
}
}
/// Builds the server with the configured options.
pub async fn build(self) -> Result<Arc<Server>> {
Server::init(self.inner, None).await
}
/// Builds the server with the configured options and an executor.
pub async fn build_with_executor(self, ex: Executor) -> Result<Arc<Server>> {
Server::init(self.inner, Some(ex)).await
}
}
impl Server {
/// Creates a new [`ServerBuilder`]
///
/// This function initializes a `ServerBuilder` with the specified endpoint.
///
/// # Example
///
/// ```
/// use karyon_jsonrpc::Server;
/// async {
/// let server = Server::builder("ws://127.0.0.1:3000")
/// .expect("Create a new server builder")
/// .build().await
/// .expect("Build the server");
/// };
/// ```
pub fn builder(endpoint: impl ToEndpoint) -> Result<ServerBuilder> {
let endpoint = endpoint.to_endpoint()?;
Ok(ServerBuilder {
inner: ServerConfig {
endpoint,
services: HashMap::new(),
pubsub_services: HashMap::new(),
#[cfg(feature = "tcp")]
tcp_config: Default::default(),
#[cfg(feature = "tls")]
tls_config: None,
},
})
}
}
|
