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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
//! A [`Socket`] represents a client connected to a namespace.
//! The socket struct itself should not be used directly, but through a [`SocketRef`](crate::extract::SocketRef).
use std::{
borrow::Cow,
collections::HashMap,
fmt::Debug,
sync::Mutex,
sync::{
atomic::{AtomicI64, Ordering},
Arc, RwLock,
},
time::Duration,
};
use engineioxide::{sid::Sid, socket::DisconnectReason as EIoDisconnectReason};
use serde::{de::DeserializeOwned, Serialize};
use serde_json::Value;
use tokio::sync::oneshot;
#[cfg(feature = "extensions")]
use crate::extensions::Extensions;
use crate::{
adapter::{Adapter, LocalAdapter, Room},
errors::{AckError, Error},
handler::{
BoxedDisconnectHandler, BoxedMessageHandler, DisconnectHandler, MakeErasedHandler,
MessageHandler,
},
ns::Namespace,
operators::{Operators, RoomParam},
packet::{BinaryPacket, Packet, PacketData},
SocketIoConfig,
};
use crate::{
client::SocketData,
errors::{AdapterError, SendError},
};
/// All the possible reasons for a [`Socket`] to be disconnected from a namespace.
///
/// It can be used as an extractor in the [`on_disconnect`](crate::handler::disconnect) handler.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum DisconnectReason {
/// The client gracefully closed the connection
TransportClose,
/// The client sent multiple polling requests at the same time (it is forbidden according to the engine.io protocol)
MultipleHttpPollingError,
/// The client sent a bad request / the packet could not be parsed correctly
PacketParsingError,
/// The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)
TransportError,
/// The client did not send a PONG packet in the `ping timeout` delay
HeartbeatTimeout,
/// The client has manually disconnected the socket using [`socket.disconnect()`](https://socket.io/fr/docs/v4/client-api/#socketdisconnect)
ClientNSDisconnect,
/// The socket was forcefully disconnected from the namespace with [`Socket::disconnect`]
ServerNSDisconnect,
/// The server is being closed
ClosingServer,
}
impl std::fmt::Display for DisconnectReason {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
use DisconnectReason::*;
let str: &'static str = match self {
TransportClose => "client gracefully closed the connection",
MultipleHttpPollingError => "client sent multiple polling requests at the same time",
PacketParsingError => "client sent a bad request / the packet could not be parsed",
TransportError => "The connection was abruptly closed",
HeartbeatTimeout => "client did not send a PONG packet in time",
ClientNSDisconnect => "client has manually disconnected the socket from the namespace",
ServerNSDisconnect => "socket was forcefully disconnected from the namespace",
ClosingServer => "server is being closed",
};
f.write_str(str)
}
}
impl From<EIoDisconnectReason> for DisconnectReason {
fn from(reason: EIoDisconnectReason) -> Self {
use DisconnectReason::*;
match reason {
EIoDisconnectReason::TransportClose => TransportClose,
EIoDisconnectReason::TransportError => TransportError,
EIoDisconnectReason::HeartbeatTimeout => HeartbeatTimeout,
EIoDisconnectReason::MultipleHttpPollingError => MultipleHttpPollingError,
EIoDisconnectReason::PacketParsingError => PacketParsingError,
EIoDisconnectReason::ClosingServer => ClosingServer,
}
}
}
/// An acknowledgement sent by the client.
/// It contains the data sent by the client and the binary payloads if there are any.
#[derive(Debug)]
pub struct AckResponse<T> {
/// The data returned by the client
pub data: T,
/// Optional binary payloads
///
/// If there is no binary payload, the `Vec` will be empty
pub binary: Vec<Vec<u8>>,
}
/// A Socket represents a client connected to a namespace.
/// It is used to send and receive messages from the client, join and leave rooms, etc.
/// The socket struct itself should not be used directly, but through a [`SocketRef`](crate::extract::SocketRef).
pub struct Socket<A: Adapter = LocalAdapter> {
config: Arc<SocketIoConfig>,
ns: Arc<Namespace<A>>,
message_handlers: RwLock<HashMap<Cow<'static, str>, BoxedMessageHandler<A>>>,
disconnect_handler: Mutex<Option<BoxedDisconnectHandler<A>>>,
ack_message: Mutex<HashMap<i64, oneshot::Sender<AckResponse<Value>>>>,
ack_counter: AtomicI64,
/// The socket id
pub id: Sid,
/// A type map of protocol extensions.
/// It can be used to share data through the lifetime of the socket.
/// Because it uses a [`DashMap`](dashmap::DashMap) internally, it is thread safe but be careful about deadlocks!
///
/// **Note**: This is note the same data than the `extensions` field on the [`http::Request::extensions()`](http::Request) struct.
#[cfg_attr(docsrs, doc(cfg(feature = "extensions")))]
#[cfg(feature = "extensions")]
pub extensions: Extensions,
esocket: Arc<engineioxide::Socket<SocketData>>,
}
impl<A: Adapter> Socket<A> {
pub(crate) fn new(
sid: Sid,
ns: Arc<Namespace<A>>,
esocket: Arc<engineioxide::Socket<SocketData>>,
config: Arc<SocketIoConfig>,
) -> Self {
Self {
ns,
message_handlers: RwLock::new(HashMap::new()),
disconnect_handler: Mutex::new(None),
ack_message: Mutex::new(HashMap::new()),
ack_counter: AtomicI64::new(0),
id: sid,
#[cfg(feature = "extensions")]
extensions: Extensions::new(),
config,
esocket,
}
}
/// ### Registers a [`MessageHandler`] for the given event.
///
/// * See the [`message`](crate::handler::message) module doc for more details on message handler.
/// * See the [`extract`](crate::extract) module doc for more details on available extractors.
///
/// #### Simple example with a sync closure:
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde::{Serialize, Deserialize};
/// #[derive(Debug, Serialize, Deserialize)]
/// struct MyData {
/// name: String,
/// age: u8,
/// }
///
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// // Register a handler for the "test" event and extract the data as a `MyData` struct
/// // With the Data extractor, the handler is called only if the data can be deserialized as a `MyData` struct
/// // If you want to manage errors yourself you can use the TryData extractor
/// socket.on("test", |socket: SocketRef, Data::<MyData>(data)| {
/// println!("Received a test message {:?}", data);
/// socket.emit("test-test", MyData { name: "Test".to_string(), age: 8 }).ok(); // Emit a message to the client
/// });
/// });
///
/// ```
///
/// #### Example with a closure and an acknowledgement + binary data:
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use serde::{Serialize, Deserialize};
/// #[derive(Debug, Serialize, Deserialize)]
/// struct MyData {
/// name: String,
/// age: u8,
/// }
///
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// // Register an async handler for the "test" event and extract the data as a `MyData` struct
/// // Extract the binary payload as a `Vec<Vec<u8>>` with the Bin extractor.
/// // It should be the last extractor because it consumes the request
/// socket.on("test", |socket: SocketRef, Data::<MyData>(data), ack: AckSender, Bin(bin)| async move {
/// println!("Received a test message {:?}", data);
/// tokio::time::sleep(std::time::Duration::from_secs(1)).await;
/// ack.bin(bin).send(data).ok(); // The data received is sent back to the client through the ack
/// socket.emit("test-test", MyData { name: "Test".to_string(), age: 8 }).ok(); // Emit a message to the client
/// });
/// });
/// ```
pub fn on<H, T>(&self, event: impl Into<Cow<'static, str>>, handler: H)
where
H: MessageHandler<A, T>,
T: Send + Sync + 'static,
{
self.message_handlers
.write()
.unwrap()
.insert(event.into(), MakeErasedHandler::new_message_boxed(handler));
}
/// ## Registers a disconnect handler.
/// You can register only one disconnect handler per socket. If you register multiple handlers, only the last one will be used.
///
/// * See the [`disconnect`](crate::handler::disconnect) module doc for more details on disconnect handler.
/// * See the [`extract`](crate::extract) module doc for more details on available extractors.
///
/// The callback will be called when the socket is disconnected from the server or the client or when the underlying connection crashes.
/// A [`DisconnectReason`] is passed to the callback to indicate the reason for the disconnection.
/// ### Example
/// ```
/// # use socketioxide::{SocketIo, socket::DisconnectReason, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef| async move {
/// // Close the current socket
/// socket.disconnect().ok();
/// });
/// socket.on_disconnect(|socket: SocketRef, reason: DisconnectReason| async move {
/// println!("Socket {} on ns {} disconnected, reason: {:?}", socket.id, socket.ns(), reason);
/// });
/// });
pub fn on_disconnect<C, T>(&self, callback: C)
where
C: DisconnectHandler<A, T> + Send + Sync + 'static,
T: Send + Sync + 'static,
{
let handler = MakeErasedHandler::new_disconnect_boxed(callback);
self.disconnect_handler.lock().unwrap().replace(handler);
}
/// Emits a message to the client
/// ## Errors
/// * If the data cannot be serialized to JSON, a [`SendError::Serialize`] is returned.
/// * If the packet buffer is full, a [`SendError::InternalChannelFull`] is returned.
/// See [`SocketIoBuilder::max_buffer_size`](crate::SocketIoBuilder) option for more infos on internal buffer config
/// ## Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// // Emit a test message to the client
/// socket.emit("test", data).ok();
/// });
/// });
/// ```
pub fn emit(
&self,
event: impl Into<Cow<'static, str>>,
data: impl Serialize,
) -> Result<(), SendError> {
let ns = self.ns();
let data = serde_json::to_value(data)?;
if let Err(e) = self.send(Packet::event(ns, event.into(), data)) {
#[cfg(feature = "tracing")]
tracing::debug!("sending error during emit message: {e:?}");
return Err(e);
}
Ok(())
}
/// Emits a message to the client and wait for acknowledgement.
///
/// The acknowledgement has a timeout specified in the config (5s by default)
/// (see [`SocketIoBuilder::ack_timeout`](crate::SocketIoBuilder)) or with the `timeout()` operator.
///
/// ## Errors
/// * If the data cannot be serialized to JSON, a [`AckError::Serialize`] is returned.
/// * If the packet could not be sent, a [`AckError::SendChannel`] is returned.
/// * In case of timeout an [`AckError::Timeout`] is returned.
/// ##### Example without custom timeout
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// // Emit a test message and wait for an acknowledgement with the timeout specified in the config
/// match socket.emit_with_ack::<Value>("test", data).await {
/// Ok(ack) => println!("Ack received {:?}", ack),
/// Err(err) => println!("Ack error {:?}", err),
/// }
/// });
/// });
/// ```
pub async fn emit_with_ack<V>(
&self,
event: impl Into<Cow<'static, str>>,
data: impl Serialize,
) -> Result<AckResponse<V>, AckError>
where
V: DeserializeOwned + Send + Sync + 'static,
{
let ns = self.ns();
let data = serde_json::to_value(data)?;
let packet = Packet::event(Cow::Borrowed(ns), event.into(), data);
self.send_with_ack(packet, None).await
}
// Room actions
/// Joins the given rooms.
///
/// If the room does not exist, it will be created.
///
/// ## Errors
/// When using a distributed adapter, it can return an [`Adapter::Error`] which is mostly related to network errors.
/// For the default [`LocalAdapter`] it is always an [`Infallible`](std::convert::Infallible) error
pub fn join(&self, rooms: impl RoomParam) -> Result<(), A::Error> {
self.ns.adapter.add_all(self.id, rooms)
}
/// Leaves the given rooms.
///
/// If the room does not exist, it will do nothing
/// ## Errors
/// When using a distributed adapter, it can return an [`Adapter::Error`] which is mostly related to network errors.
/// For the default [`LocalAdapter`] it is always an [`Infallible`](std::convert::Infallible) error
pub fn leave(&self, rooms: impl RoomParam) -> Result<(), A::Error> {
self.ns.adapter.del(self.id, rooms)
}
/// Leaves all rooms where the socket is connected.
/// ## Errors
/// When using a distributed adapter, it can return an [`Adapter::Error`] which is mostly related to network errors.
/// For the default [`LocalAdapter`] it is always an [`Infallible`](std::convert::Infallible) error
pub fn leave_all(&self) -> Result<(), A::Error> {
self.ns.adapter.del_all(self.id)
}
/// Gets all rooms where the socket is connected.
/// ## Errors
/// When using a distributed adapter, it can return an [`Adapter::Error`] which is mostly related to network errors.
/// For the default [`LocalAdapter`] it is always an [`Infallible`](std::convert::Infallible) error
pub fn rooms(&self) -> Result<Vec<Room>, A::Error> {
self.ns.adapter.socket_rooms(self.id)
}
// Socket operators
/// Selects all clients in the given rooms except the current socket.
///
/// If you want to include the current socket, use the `within()` operator.
/// ##### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// let other_rooms = "room4".to_string();
/// // In room1, room2, room3 and room4 except the current
/// socket
/// .to("room1")
/// .to(["room2", "room3"])
/// .to(vec![other_rooms])
/// .emit("test", data);
/// });
/// });
pub fn to(&self, rooms: impl RoomParam) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).to(rooms)
}
/// Selects all clients in the given rooms.
///
/// It does include the current socket contrary to the `to()` operator.
/// #### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// let other_rooms = "room4".to_string();
/// // In room1, room2, room3 and room4 including the current socket
/// socket
/// .within("room1")
/// .within(["room2", "room3"])
/// .within(vec![other_rooms])
/// .emit("test", data);
/// });
/// });
pub fn within(&self, rooms: impl RoomParam) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).within(rooms)
}
/// Filters out all clients selected with the previous operators which are in the given rooms.
/// ##### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("register1", |socket: SocketRef, Data::<Value>(data)| async move {
/// socket.join("room1");
/// });
/// socket.on("register2", |socket: SocketRef, Data::<Value>(data)| async move {
/// socket.join("room2");
/// });
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// // This message will be broadcast to all clients in the Namespace
/// // except for ones in room1 and the current socket
/// socket.broadcast().except("room1").emit("test", data);
/// });
/// });
pub fn except(&self, rooms: impl RoomParam) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).except(rooms)
}
/// Broadcasts to all clients only connected on this node (when using multiple nodes).
/// When using the default in-memory [`LocalAdapter`], this operator is a no-op.
/// ##### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// // This message will be broadcast to all clients in this namespace and connected on this node
/// socket.local().emit("test", data);
/// });
/// });
pub fn local(&self) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).local()
}
/// Sets a custom timeout when sending a message with an acknowledgement.
///
/// ##### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use futures::stream::StreamExt;
/// # use std::time::Duration;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data), Bin(bin)| async move {
/// // Emit a test message in the room1 and room3 rooms, except for the room2 room with the binary payload received, wait for 5 seconds for an acknowledgement
/// socket.to("room1")
/// .to("room3")
/// .except("room2")
/// .bin(bin)
/// .timeout(Duration::from_secs(5))
/// .emit_with_ack::<Value>("message-back", data).unwrap().for_each(|ack| async move {
/// match ack {
/// Ok(ack) => println!("Ack received {:?}", ack),
/// Err(err) => println!("Ack error {:?}", err),
/// }
/// }).await;
/// });
/// });
///
pub fn timeout(&self, timeout: Duration) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).timeout(timeout)
}
/// Adds a binary payload to the message.
/// ##### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data), Bin(bin)| async move {
/// // This will send the binary payload received to all clients in this namespace with the test message
/// socket.bin(bin).emit("test", data);
/// });
/// });
pub fn bin(&self, binary: Vec<Vec<u8>>) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).bin(binary)
}
/// Broadcasts to all clients without any filtering (except the current socket).
/// ##### Example
/// ```
/// # use socketioxide::{SocketIo, extract::*};
/// # use serde_json::Value;
/// # use std::sync::Arc;
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef| {
/// socket.on("test", |socket: SocketRef, Data::<Value>(data)| async move {
/// // This message will be broadcast to all clients in this namespace
/// socket.broadcast().emit("test", data);
/// });
/// });
pub fn broadcast(&self) -> Operators<A> {
Operators::new(self.ns.clone(), Some(self.id)).broadcast()
}
/// Disconnects the socket from the current namespace,
///
/// It will also call the disconnect handler if it is set.
pub fn disconnect(self: Arc<Self>) -> Result<(), SendError> {
self.send(Packet::disconnect(&self.ns.path))?;
self.close(DisconnectReason::ServerNSDisconnect)?;
Ok(())
}
/// Closes the engine.io connection if it is not already closed.
/// Return a future that resolves when the underlying transport is closed.
pub(crate) async fn close_underlying_transport(&self) {
if !self.esocket.is_closed() {
#[cfg(feature = "tracing")]
tracing::debug!("closing underlying transport for socket: {}", self.id);
self.esocket.close(EIoDisconnectReason::ClosingServer);
}
self.esocket.closed().await;
}
/// Gets the current namespace path.
pub fn ns(&self) -> &str {
&self.ns.path
}
pub(crate) fn send(&self, mut packet: Packet<'_>) -> Result<(), SendError> {
let bin_payloads = match packet.inner {
PacketData::BinaryEvent(_, ref mut bin, _) | PacketData::BinaryAck(ref mut bin, _) => {
Some(std::mem::take(&mut bin.bin))
}
_ => None,
};
let msg = packet.try_into()?;
self.esocket.emit(msg)?;
if let Some(bin_payloads) = bin_payloads {
for bin in bin_payloads {
self.esocket.emit_binary(bin)?;
}
}
Ok(())
}
pub(crate) async fn send_with_ack<'a, V: DeserializeOwned>(
&self,
mut packet: Packet<'a>,
timeout: Option<Duration>,
) -> Result<AckResponse<V>, AckError> {
let (tx, rx) = oneshot::channel();
let ack = self.ack_counter.fetch_add(1, Ordering::SeqCst) + 1;
self.ack_message.lock().unwrap().insert(ack, tx);
packet.inner.set_ack_id(ack);
self.send(packet)?;
let timeout = timeout.unwrap_or(self.config.ack_timeout);
let v = tokio::time::timeout(timeout, rx).await??;
Ok(AckResponse {
data: serde_json::from_value(v.data)?,
binary: v.binary,
})
}
/// Called when the socket is gracefully disconnected from the server or the client
///
/// It maybe also close when the underlying transport is closed or failed.
pub(crate) fn close(self: Arc<Self>, reason: DisconnectReason) -> Result<(), AdapterError> {
if let Some(handler) = self.disconnect_handler.lock().unwrap().take() {
handler.call(self.clone(), reason);
}
self.ns.remove_socket(self.id)?;
Ok(())
}
// Receives data from client:
pub(crate) fn recv(self: Arc<Self>, packet: PacketData<'_>) -> Result<(), Error> {
match packet {
PacketData::Event(e, data, ack) => self.recv_event(&e, data, ack),
PacketData::EventAck(data, ack_id) => self.recv_ack(data, ack_id),
PacketData::BinaryEvent(e, packet, ack) => self.recv_bin_event(&e, packet, ack),
PacketData::BinaryAck(packet, ack) => self.recv_bin_ack(packet, ack),
PacketData::Disconnect => self
.close(DisconnectReason::ClientNSDisconnect)
.map_err(Error::from),
_ => unreachable!(),
}
}
/// Gets the request info made by the client to connect
///
/// Note that the `extensions` field will be empty and will not
/// contain extensions set in the previous http layers for requests initialized with ws transport.
///
/// It is because [`http::Extensions`] is not cloneable and is needed for ws upgrade.
pub fn req_parts(&self) -> &http::request::Parts {
&self.esocket.req_parts
}
/// Gets the [`TransportType`](crate::TransportType) used by the client to connect with this [`Socket`]
///
/// It can also be accessed as an extractor:
/// ```
/// # use socketioxide::{SocketIo, TransportType, extract::*};
///
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef, transport: TransportType| {
/// assert_eq!(socket.transport_type(), transport);
/// });
pub fn transport_type(&self) -> crate::TransportType {
self.esocket.transport_type()
}
/// Gets the socket.io [`ProtocolVersion`](crate::ProtocolVersion) used by the client to connect with this [`Socket`]
///
/// It can also be accessed as an extractor:
/// ## Example
/// ```
/// # use socketioxide::{SocketIo, ProtocolVersion, extract::*};
///
/// let (_, io) = SocketIo::new_svc();
/// io.ns("/", |socket: SocketRef, v: ProtocolVersion| {
/// assert_eq!(socket.protocol(), v);
/// });
pub fn protocol(&self) -> crate::ProtocolVersion {
self.esocket.protocol.into()
}
fn recv_event(self: Arc<Self>, e: &str, data: Value, ack: Option<i64>) -> Result<(), Error> {
if let Some(handler) = self.message_handlers.read().unwrap().get(e) {
handler.call(self.clone(), data, vec![], ack);
}
Ok(())
}
fn recv_bin_event(
self: Arc<Self>,
e: &str,
packet: BinaryPacket,
ack: Option<i64>,
) -> Result<(), Error> {
if let Some(handler) = self.message_handlers.read().unwrap().get(e) {
handler.call(self.clone(), packet.data, packet.bin, ack);
}
Ok(())
}
fn recv_ack(self: Arc<Self>, data: Value, ack: i64) -> Result<(), Error> {
if let Some(tx) = self.ack_message.lock().unwrap().remove(&ack) {
let res = AckResponse {
data,
binary: vec![],
};
tx.send(res).ok();
}
Ok(())
}
fn recv_bin_ack(self: Arc<Self>, packet: BinaryPacket, ack: i64) -> Result<(), Error> {
if let Some(tx) = self.ack_message.lock().unwrap().remove(&ack) {
let res = AckResponse {
data: packet.data,
binary: packet.bin,
};
tx.send(res).ok();
}
Ok(())
}
}
impl<A: Adapter> Debug for Socket<A> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Socket")
.field("ns", &self.ns())
.field("ack_message", &self.ack_message)
.field("ack_counter", &self.ack_counter)
.field("sid", &self.id)
.finish()
}
}
#[cfg(test)]
impl<A: Adapter> Socket<A> {
pub fn new_dummy(sid: Sid, ns: Arc<Namespace<A>>) -> Socket<A> {
let close_fn = Box::new(move |_, _| ());
Socket::new(
sid,
ns,
engineioxide::Socket::new_dummy(sid, close_fn).into(),
Arc::new(SocketIoConfig::default()),
)
}
}