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
|
use std::sync::Arc;
#[cfg(feature = "smol")]
use futures_rustls::rustls;
#[cfg(feature = "tokio")]
use tokio_rustls::rustls;
use karyon_core::async_util::TaskGroup;
use karyon_net::{tls::ClientTlsConfig, Conn, Endpoint, ToEndpoint};
#[cfg(feature = "ws")]
use karyon_net::ws::{ClientWsConfig, ClientWssConfig};
#[cfg(feature = "ws")]
use crate::codec::WsJsonCodec;
use crate::{codec::JsonCodec, Error, Result, TcpConfig};
use super::{Client, MessageDispatcher, Subscriptions};
const DEFAULT_TIMEOUT: u64 = 3000; // 3s
impl Client {
/// Creates a new [`ClientBuilder`]
///
/// This function initializes a `ClientBuilder` with the specified endpoint.
///
/// # Example
///
/// ```ignore
/// let builder = Client::builder("ws://127.0.0.1:3000")?.build()?;
/// ```
pub fn builder(endpoint: impl ToEndpoint) -> Result<ClientBuilder> {
let endpoint = endpoint.to_endpoint()?;
Ok(ClientBuilder {
endpoint,
timeout: Some(DEFAULT_TIMEOUT),
tls_config: None,
tcp_config: Default::default(),
})
}
}
/// Builder for constructing an RPC [`Client`].
pub struct ClientBuilder {
endpoint: Endpoint,
tls_config: Option<(rustls::ClientConfig, String)>,
tcp_config: TcpConfig,
timeout: Option<u64>,
}
impl ClientBuilder {
/// Set timeout for receiving messages, in milliseconds. Requests will
/// fail if it takes longer.
///
/// # Examples
///
/// ```ignore
/// let client = Client::builder()?.set_timeout(5000).build()?;
/// ```
pub fn set_timeout(mut self, timeout: u64) -> Self {
self.timeout = Some(timeout);
self
}
/// Configure TCP settings for the client.
///
/// # Example
///
/// ```ignore
/// let tcp_config = TcpConfig::default();
/// let client = Client::builder()?.tcp_config(tcp_config)?.build()?;
/// ```
///
/// This function will return an error if the endpoint does not support TCP protocols.
pub fn tcp_config(mut self, config: TcpConfig) -> Result<Self> {
match self.endpoint {
Endpoint::Tcp(..) | Endpoint::Tls(..) | Endpoint::Ws(..) | Endpoint::Wss(..) => {
self.tcp_config = config;
Ok(self)
}
_ => Err(Error::UnsupportedProtocol(self.endpoint.to_string())),
}
}
/// Configure TLS settings for the client.
///
/// # Example
///
/// ```ignore
/// let tls_config = rustls::ClientConfig::new(...);
/// let client = Client::builder()?.tls_config(tls_config, "example.com")?.build()?;
/// ```
///
/// This function will return an error if the endpoint does not support TLS protocols.
pub fn tls_config(mut self, config: rustls::ClientConfig, dns_name: &str) -> Result<Self> {
match self.endpoint {
Endpoint::Tcp(..) | Endpoint::Tls(..) | Endpoint::Ws(..) | Endpoint::Wss(..) => {
self.tls_config = Some((config, dns_name.to_string()));
Ok(self)
}
_ => Err(Error::UnsupportedProtocol(self.endpoint.to_string())),
}
}
/// Build RPC client from [`ClientBuilder`].
///
/// This function creates a new RPC client using the configurations
/// specified in the `ClientBuilder`. It returns a `Arc<Client>` on success.
///
/// # Example
///
/// ```ignore
/// let client = Client::builder(endpoint)?
/// .set_timeout(5000)
/// .tcp_config(tcp_config)?
/// .tls_config(tls_config, "example.com")?
/// .build()
/// .await?;
/// ```
pub async fn build(self) -> Result<Arc<Client>> {
let conn: Conn<serde_json::Value> = match self.endpoint {
Endpoint::Tcp(..) | Endpoint::Tls(..) => match self.tls_config {
Some((conf, dns_name)) => Box::new(
karyon_net::tls::dial(
&self.endpoint,
ClientTlsConfig {
dns_name,
client_config: conf,
tcp_config: self.tcp_config,
},
JsonCodec {},
)
.await?,
),
None => Box::new(
karyon_net::tcp::dial(&self.endpoint, self.tcp_config, JsonCodec {}).await?,
),
},
#[cfg(feature = "ws")]
Endpoint::Ws(..) | Endpoint::Wss(..) => match self.tls_config {
Some((conf, dns_name)) => Box::new(
karyon_net::ws::dial(
&self.endpoint,
ClientWsConfig {
tcp_config: self.tcp_config,
wss_config: Some(ClientWssConfig {
dns_name,
client_config: conf,
}),
},
WsJsonCodec {},
)
.await?,
),
None => {
let config = ClientWsConfig {
tcp_config: self.tcp_config,
wss_config: None,
};
Box::new(karyon_net::ws::dial(&self.endpoint, config, WsJsonCodec {}).await?)
}
},
#[cfg(all(feature = "unix", target_family = "unix"))]
Endpoint::Unix(..) => Box::new(
karyon_net::unix::dial(&self.endpoint, Default::default(), JsonCodec {}).await?,
),
_ => return Err(Error::UnsupportedProtocol(self.endpoint.to_string())),
};
let client = Arc::new(Client {
timeout: self.timeout,
conn,
message_dispatcher: MessageDispatcher::new(),
subscriptions: Subscriptions::new(),
task_group: TaskGroup::new(),
});
client.start_background_receiving();
Ok(client)
}
}
|
