Struct script::dom::websocket::WebSocket

#[repr(C)]
pub struct WebSocket {
    eventtarget: EventTarget,
    url: ServoUrl,
    ready_state: Cell<WebSocketRequestState>,
    buffered_amount: Cell<u64>,
    clearing_buffer: Cell<bool>,
    sender: IpcSender<WebSocketDomAction>,
    binary_type: Cell<BinaryType>,
    protocol: DomRefCell<String>,
}

Fields

eventtarget: EventTarget

url: ServoUrl

ready_state: Cell<WebSocketRequestState>

buffered_amount: Cell<u64>

clearing_buffer: Cell<bool>

sender: IpcSender<WebSocketDomAction>

binary_type: Cell<BinaryType>

protocol: DomRefCell<String>

Implementations

impl WebSocket

fn __assert_parent_type(&self)

impl WebSocket

fn new_inherited(
    url: ServoUrl,
    sender: IpcSender<WebSocketDomAction>
) -> WebSocket

fn new(
    global: &GlobalScope,
    proto: Option<HandleObject<'_>>,
    url: ServoUrl,
    sender: IpcSender<WebSocketDomAction>
) -> Root<Dom<WebSocket>>

pub fn Constructor(
    global: &GlobalScope,
    proto: Option<HandleObject<'_>>,
    url: DOMString,
    protocols: Option<StringOrStringSequence>
) -> Result<Root<Dom<WebSocket>>, Error>

https://html.spec.whatwg.org/multipage/#dom-websocket

fn send_impl(&self, data_byte_len: u64) -> Result<bool, Error>

pub fn origin(&self) -> ImmutableOrigin

Trait Implementations

impl Castable for WebSocket

fn is<T>(&self) -> boolwhere
    T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

fn upcast<T>(&self) -> &Twhere
    T: Castable,
    Self: DerivedFrom<T>,

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T>where
    T: DerivedFrom<Self>,

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for WebSocket

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

fn global(&self) -> Root<Dom<GlobalScope>>where
    Self: Sized,

Returns the global scope of the realm that the DomObject was created in.

impl DomObjectWrap for WebSocket

const WRAP: unsafe fn(_: SafeJSContext, _: &GlobalScope, _: Option<HandleObject<'_>>, _: Box<Self>) -> Root<Dom<Self>> = {dom::bindings::codegen::Bindings::WebSocketBinding::WebSocket_Binding::Wrap as for<'a, 'b> unsafe fn(script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::websocket::WebSocket>) -> dom::bindings::root::Root<dom::bindings::root::Dom<dom::websocket::WebSocket>>}

Function pointer to the general wrap function type

impl HasParent for WebSocket

fn as_parent(&self) -> &EventTarget

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = EventTarget

impl IDLInterface for WebSocket

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for WebSocket

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MutDomObject for WebSocket

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq<WebSocket> for WebSocket

fn eq(&self, other: &WebSocket) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToJSValConvertible for WebSocket

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for WebSocket

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl WebSocketMethods for WebSocket

fn GetOnopen(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnopen(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnclose(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnclose(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnerror(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnerror(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn GetOnmessage(&self) -> Option<Rc<EventHandlerNonNull>>

fn SetOnmessage(&self, listener: Option<Rc<EventHandlerNonNull>>)

fn Url(&self) -> DOMString

fn ReadyState(&self) -> u16

fn BufferedAmount(&self) -> u64

fn BinaryType(&self) -> BinaryType

fn SetBinaryType(&self, btype: BinaryType)

fn Protocol(&self) -> DOMString

fn Send(&self, data: USVString) -> Result<(), Error>

fn Send_(&self, blob: &Blob) -> Result<(), Error>

fn Send__(
    &self,
    array: CustomAutoRooterGuard<'_, ArrayBuffer>
) -> Result<(), Error>

fn Send___(
    &self,
    array: CustomAutoRooterGuard<'_, ArrayBufferView>
) -> Result<(), Error>

fn Close(&self, code: Option<u16>, reason: Option<USVString>) -> Result<(), Error>

impl DerivedFrom<EventTarget> for WebSocket