Skip to content

Class CreateLinkEvent

Namespace: Void.Proxy.Api.Events.Links
Assembly: Void.Proxy.Api.dll

Requests creation of the link that will relay traffic between a player and a destination server.

public record CreateLinkEvent : IScopedEventWithResult<ILink>, IScopedEvent, IEventWithResult<ILink>, IEvent, IEquatable<CreateLinkEvent>

Inheritance

objectCreateLinkEvent

Implements

IScopedEventWithResult<ILink>, IScopedEvent, IEventWithResult<ILink>, IEvent, IEquatable<CreateLinkEvent>

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

CreateLinkEvent(IPlayer, IServer, INetworkChannel, INetworkChannel)

Requests creation of the link that will relay traffic between a player and a destination server.

public CreateLinkEvent(IPlayer Player, IServer Server, INetworkChannel PlayerChannel, INetworkChannel ServerChannel)

Parameters

Player IPlayer

The player to associate with the link.

Server IServer

The destination server to associate with the link.

PlayerChannel INetworkChannel

The player-facing network channel.

ServerChannel INetworkChannel

The destination-server network channel.

Properties

Player

The player to associate with the link.

public IPlayer Player { get; init; }

Property Value

IPlayer

PlayerChannel

The player-facing network channel.

public INetworkChannel PlayerChannel { get; init; }

Property Value

INetworkChannel

Result

Gets or sets a custom link created by a listener.

public ILink? Result { get; set; }

Property Value

ILink?

Server

The destination server to associate with the link.

public IServer Server { get; init; }

Property Value

IServer

ServerChannel

The destination-server network channel.

public INetworkChannel ServerChannel { get; init; }

Property Value

INetworkChannel