livekit-rpc 0.1.5

RPC core logic for LiveKit
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

// Copyright 2026 LiveKit, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! The seam between the RPC managers and whatever actually moves bytes.

use livekit_common::RemoteParticipantRegistry;
use livekit_data_stream::api::{StreamResult, StreamTextOptions, TextStreamInfo};
use livekit_protocol as proto;
use std::future::Future;

/// Error returned by the transport when an RPC data packet fails to send.
///
/// The RPC managers only need a message to attach to the resulting
/// [`RpcError`](crate::api::RpcError); the concrete engine error type stays in the `livekit`
/// crate, which implements [`RpcTransport`] over the RTC engine.
#[derive(Debug, Clone, thiserror::Error)]
#[error("{0}")]
pub struct RpcTransportError(String);

impl RpcTransportError {
    /// Wraps a transport-level failure, preserving its message for the RPC error payload.
    pub fn new(source: impl std::fmt::Display) -> Self {
        Self(source.to_string())
    }
}

/// Transport abstraction for RPC operations.
///
/// Decouples the RPC managers from concrete engine/session types,
/// enabling in-memory unit testing with a mock transport.
pub trait RpcTransport: RemoteParticipantRegistry {
    /// Send a data packet (used for v1 RPC packets and ACKs).
    fn publish_data(
        &self,
        data: proto::DataPacket,
    ) -> impl Future<Output = Result<(), RpcTransportError>> + Send;

    /// Send text as a data stream (used for v2 RPC requests and responses).
    fn send_text(
        &self,
        text: &str,
        options: StreamTextOptions,
    ) -> impl Future<Output = StreamResult<TextStreamInfo>> + Send;

    /// Get the server version string, if available.
    fn server_version(&self) -> Option<String>;
}