Struct Server 

pub struct Server { /* private fields */ }

Live server handle: an address bound to an EvalSite, its codec and threading configuration, lifecycle status, triggers, and optional ServerRuntime.

Implementations

impl Server

pub fn new( address: ServerAddress, default_codec: Symbol, supported_codecs: Vec<Symbol>, thread: ThreadMode, isolation: IsolationPolicy, name: Option<Symbol>, site: Arc<dyn EvalSite>, spec: Vec<(Symbol, Expr)>, ) -> Result<Self>

Builds a server without an attached runtime.

pub fn with_runtime( address: ServerAddress, default_codec: Symbol, supported_codecs: Vec<Symbol>, thread: ThreadMode, isolation: IsolationPolicy, name: Option<Symbol>, site: Arc<dyn EvalSite>, spec: Vec<(Symbol, Expr)>, runtime: Option<Arc<ServerRuntime>>, ) -> Result<Self>

Builds a server, optionally attaching a ServerRuntime, after verifying the address transport is available.

pub fn id(&self) -> u64

Returns this server’s unique id.

pub fn name(&self) -> Option<&Symbol>

Returns the server’s name, if one was assigned.

pub fn address(&self) -> &ServerAddress

Returns the address the server is bound to.

pub fn default_codec(&self) -> &Symbol

Returns the codec used by default for frames.

pub fn supported_codecs(&self) -> &[Symbol]

Returns the codecs the server is willing to negotiate.

pub fn thread(&self) -> &ThreadMode

Returns the server’s threading mode.

pub fn site(&self) -> &Arc<dyn EvalSite>

Returns the eval site that handles incoming frames.

pub fn isolation(&self) -> &IsolationPolicy

Returns the isolation policy applied to sessions.

pub fn spec(&self) -> &[(Symbol, Expr)]

Returns the configuration spec entries the server was started with.

pub fn runtime(&self) -> Option<&Arc<ServerRuntime>>

Returns the attached runtime, if the server is listening.

pub fn status(&self) -> ServerStatus

Returns the current lifecycle status.

pub fn set_status(&self, status: ServerStatus)

Sets the lifecycle status.

pub fn uptime_millis(&self) -> u64

Returns the elapsed time since the server started, in milliseconds.

pub fn register_trigger(&self, trigger: Arc<TriggerHandle>) -> Result<()>

Registers a trigger handle to be tracked and stopped with the server.

pub fn stop_triggers(&self) -> Result<()>

Stops every registered trigger.

pub fn deliver_trigger_frame( &self, cx: &mut Cx, frame: ServerFrame, ) -> Result<()>

Buffers frame as inbound and delivers it to the eval site, as if fired by a trigger.

pub fn trigger_snapshots(&self) -> Result<Vec<Arc<TriggerHandle>>>

Returns a snapshot of the currently registered trigger handles.

pub fn reflect_value(&self, cx: &mut Cx) -> Result<Value>

Returns a table value reflecting the server’s configuration and live state.

pub fn health_value(&self, cx: &mut Cx) -> Result<Value>

Returns a table value summarizing health: status, uptime, and session and message counts.

pub fn sessions_value(&self, cx: &mut Cx) -> Result<Value>

Returns a list value of the runtime’s sessions, or an empty list if not listening.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Object for Server

fn display(&self, _cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for Server

fn class(&self, cx: &mut Cx) -> Result<ClassRef>

Class object this value belongs to; defaults to nil.

fn as_expr(&self, cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_table(&self, cx: &mut Cx) -> Result<Value>

Project the object into a table value; the default exposes its display.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.