Struct RpcServer

pub struct RpcServer(/* private fields */);

A type that represents a foreign instance of RpcServer.

Implementations

impl RpcServer

pub fn new_vsock( service: SpIBinder, cid: u32, port: u32, ) -> Result<(RpcServer, u32), Error>

Creates a binder RPC server, serving the supplied binder service implementation on the given vsock port. Only connections from the given CID are accepted.

Set cid to [libc::VMADDR_CID_ANY] to accept connections from any client. Set cid to [libc::VMADDR_CID_LOCAL] to only bind to the local vsock interface. Set port to [libc::VMADDR_PORT_ANY] to pick an ephemeral port. The assigned port is returned with RpcServer.

pub fn new_bound_socket( service: SpIBinder, socket_fd: OwnedFd, ) -> Result<RpcServer, Error>

Creates a binder RPC server, serving the supplied binder service implementation on the given socket file descriptor. The socket should be bound to an address before calling this function.

pub fn new_unix_domain_bootstrap( service: SpIBinder, bootstrap_fd: OwnedFd, ) -> Result<RpcServer, Error>

Creates a binder RPC server that bootstraps sessions using an existing Unix domain socket pair, with a given root IBinder object. Callers should create a pair of SOCK_STREAM Unix domain sockets, pass one to the server and the other to the client. Multiple client session can be created from the client end of the pair.

pub fn new_inet( service: SpIBinder, address: &str, port: u32, ) -> Result<RpcServer, Error>

Creates a binder RPC server, serving the supplied binder service implementation on the given IP address and port.

Methods from Deref<Target = RpcServerRef>

pub fn set_supported_file_descriptor_transport_modes( &self, modes: &[FileDescriptorTransportMode], )

Sets the list of file descriptor transport modes supported by this server.

pub fn set_max_threads(&self, count: usize)

Sets the max number of threads this Server uses for incoming client connections.

This must be called before adding a client session. This corresponds to the number of incoming connections to RpcSession objects in the server, which will correspond to the number of outgoing connections in client RpcSession objects. Specifically this is useful for handling client-side callback connections.

If this is not specified, this will be a single-threaded server.

pub fn start(&self)

Starts a new background thread and calls join(). Returns immediately.

pub fn join(&self)

Joins the RpcServer thread. The call blocks until the server terminates. This must be called from exactly one thread.

pub fn shutdown(&self) -> Result<(), Error>

Shuts down the running RpcServer. Can be called multiple times and from multiple threads. Called automatically during drop().

Trait Implementations

impl AsRef<RpcServerRef> for RpcServer

fn as_ref(&self) -> &RpcServerRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RpcServerRef> for RpcServer

fn borrow(&self) -> &RpcServerRef

Immutably borrows from an owned value.

impl Debug for RpcServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for RpcServer

type Target = RpcServerRef

The resulting type after dereferencing.

fn deref(&self) -> &RpcServerRef

Dereferences the value.

impl DerefMut for RpcServer

fn deref_mut(&mut self) -> &mut RpcServerRef

Mutably dereferences the value.

impl Drop for RpcServer

fn drop(&mut self)

Executes the destructor for this type.

impl ForeignType for RpcServer

type CType = ARpcServer

The raw C type.

type Ref = RpcServerRef

The type representing a reference to this type.

unsafe fn from_ptr(ptr: *mut ARpcServer) -> RpcServer

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut ARpcServer

Returns a raw pointer to the wrapped value.

impl Send for RpcServer

SAFETY: The opaque handle can be cloned freely.

impl Sync for RpcServer

SAFETY: The underlying C++ RpcServer class is thread-safe.