Class MessageEventArgs

Represents the event data for the OnMessage event.
Inheritance
System.Object
System.EventArgs
MessageEventArgs
Inherited Members
System.EventArgs.Empty
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Mars.Common.Socket
Assembly: Mars.Common.dll
Syntax
public class MessageEventArgs : EventArgs
Remarks

That event occurs when the WebSocket receives a message or a ping if the EmitOnPing property is set to true.

If you would like to get the message data, you should access the Data or RawData property.

Properties

| Improve this Doc View Source

Data

Gets the message data as a System.String.
Declaration
public string Data { get; }
Property Value
Type Description
System.String A System.String that represents the message data if its type is text or ping and if decoding it to a string has successfully done; otherwise, null.
Remarks

That event occurs when the WebSocket receives a message or a ping if the EmitOnPing property is set to true.

If you would like to get the message data, you should access the Data or RawData property.

| Improve this Doc View Source

IsBinary

Gets a value indicating whether the message type is binary.
Declaration
public bool IsBinary { get; }
Property Value
Type Description
System.Boolean true if the message type is binary; otherwise, false.
Remarks

That event occurs when the WebSocket receives a message or a ping if the EmitOnPing property is set to true.

If you would like to get the message data, you should access the Data or RawData property.

| Improve this Doc View Source

IsPing

Gets a value indicating whether the message type is ping.
Declaration
public bool IsPing { get; }
Property Value
Type Description
System.Boolean true if the message type is ping; otherwise, false.
Remarks

That event occurs when the WebSocket receives a message or a ping if the EmitOnPing property is set to true.

If you would like to get the message data, you should access the Data or RawData property.

| Improve this Doc View Source

IsText

Gets a value indicating whether the message type is text.
Declaration
public bool IsText { get; }
Property Value
Type Description
System.Boolean true if the message type is text; otherwise, false.
Remarks

That event occurs when the WebSocket receives a message or a ping if the EmitOnPing property is set to true.

If you would like to get the message data, you should access the Data or RawData property.

| Improve this Doc View Source

RawData

Gets the message data as an array of System.Byte.
Declaration
public byte[] RawData { get; }
Property Value
Type Description
System.Byte[] An array of System.Byte that represents the message data.
Remarks

That event occurs when the WebSocket receives a message or a ping if the EmitOnPing property is set to true.

If you would like to get the message data, you should access the Data or RawData property.

Extension Methods