Struct Connect

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

The command to exchange an information about application using.

Following format is required.

Setting Data	AMF Type	Value
Command Object	Object	See Command Object.

Command Object

The Command Object is written detailed informations of both applications. Concretely, several of following pair is exchanged:

Publisher side

Key	AMF Type	Description
app	String	Server application name.
type	String	"nonprivate"
flashVer	String	Either a flash player version(client) or an FLV encoder version(server).
tcUrl	String	The URL to connect server as the TCP. app value is included in this value.

Subscriber side

Key	AMF Type	Description
fpad	Boolean	Whether a proxy is used.
audioCodecs	Number	Supported audio codecs.
videoCodecs	Number	Supported video codecs.
videoFunctions	Number	Supported video functions.
objectEncoding	Number	A version of the Action Message Format.

Implementations

impl Connect

pub fn new(command_object: Object) -> Self

Constructs a Connect command.

pub fn get_command_object(&self) -> &Object

Gets the command object in this request.

Trait Implementations

impl ChunkData for Connect

const CHANNEL: Channel = Channel::System

const MESSAGE_TYPE: MessageType = MessageType::Command

impl Clone for Connect

fn clone(&self) -> Connect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connect

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

Formats the value using the given formatter.

impl Decoder<Connect> for ByteBuffer

fn decode(&mut self) -> IOResult<Connect>

Decodes bytes into a Connect command.

Errors

• InsufficientBufferLength

When some field misses.

• InconsistentMarker

When some value is inconsistent with its marker.

Examples

use sheave_core::{
    ByteBuffer,
    Decoder,
    Encoder,
    messages::{
        Connect,
        amf::v0::Object,
    }
};

let mut buffer = ByteBuffer::default();
buffer.encode(&Object::default());
assert!(Decoder::<Connect>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
assert!(Decoder::<Connect>::decode(&mut buffer).is_err())

impl Default for Connect

fn default() -> Connect

Returns the “default value” for a type.

impl Encoder<Connect> for ByteBuffer

fn encode(&mut self, connect: &Connect)

Encodes a Connect command into bytes.

impl From<Connect> for Object

fn from(connect: Connect) -> Self

Converts to this type from the input type.

impl PartialEq for Connect

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Command for Connect

impl StructuralPartialEq for Connect