Class WireFormatException

Namespace

Typhon.Protocol

Assembly

Typhon.Protocol.dll

Thrown when bytes received from the other side do not form a valid message. It carries the close code the connection is closed with, so the transport never has to classify a decoding failure itself.

public sealed class WireFormatException : Exception, ISerializable

Inheritance

object

Exception

WireFormatException

Implements

ISerializable

Inherited Members

Exception.GetBaseException()

Exception.ToString()

Exception.GetType()

Exception.TargetSite

Exception.Message

Exception.Data

Exception.InnerException

Exception.HelpLink

Exception.Source

Exception.HResult

Exception.StackTrace

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Only a decoder throws this, and only for input it received. An encoder handed values it cannot represent throws ArgumentException instead: that is a bug on the sending side, not a hostile or broken peer.

Constructors

WireFormatException(ushort, string)

Creates the exception.

public WireFormatException(ushort closeCode, string message)

Parameters

closeCode ushort

The close code the connection must be closed with (see CloseCodes).

message string

What was wrong with the input.

Properties

CloseCode

The close code the connection must be closed with: 1002 for framing, 1007 for a malformed payload, 1009 for an oversized message.

public ushort CloseCode { get; }

Property Value

ushort