Table of Contents

Class GEarthExtension

Namespace
Xabbo.GEarth
Assembly
Xabbo.GEarth.dll

A G-Earth extension protocol implementation.

public class GEarthExtension : IRemoteExtension, IExtension, IInterceptor, IConnection, IParserContext, IInterceptorContext, INotifyPropertyChanged
Inheritance
GEarthExtension
Implements
Extension Methods

Constructors

GEarthExtension(GEarthOptions?, IMessageManager?, ILoggerFactory?)

Creates a new GEarthExtension with the specified GEarthOptions.

public GEarthExtension(GEarthOptions? options = null, IMessageManager? messages = null, ILoggerFactory? loggerFactory = null)

Parameters

options GEarthOptions

The options to be used by this extension.

messages IMessageManager

The message manager to use.

loggerFactory ILoggerFactory

The logger factory to use.

Properties

DisconnectToken

Gets a cancellation token that is triggered when the connection is lost.

public CancellationToken DisconnectToken { get; }

Property Value

CancellationToken

Dispatcher

Gets the message dispatcher associated with this interceptor.

public IMessageDispatcher Dispatcher { get; }

Property Value

IMessageDispatcher

IsConnected

Gets whether a connection to the game is currently established.

public bool IsConnected { get; }

Property Value

bool

IsRunning 

public bool IsRunning { get; }

Property Value

bool

Messages

Gets the message manager.

public IMessageManager Messages { get; }

Property Value

IMessageManager

Options

Gets the options used by this extension.

public GEarthOptions Options { get; }

Property Value

GEarthOptions

Port

Gets the port that is currently being used to connect to the remote interceptor.

public int Port { get; }

Property Value

int

Session

Gets the session information for the current connection.

public Session Session { get; }

Property Value

Session

Methods

OnActivated() 

protected virtual void OnActivated()

OnConnected(ConnectedEventArgs) 

protected virtual void OnConnected(ConnectedEventArgs e)

Parameters

e ConnectedEventArgs

OnDisconnected() 

protected virtual void OnDisconnected()

OnInitialized(InitializedEventArgs) 

protected virtual void OnInitialized(InitializedEventArgs e)

Parameters

e InitializedEventArgs

OnIntercepted(Intercept) 

protected virtual void OnIntercepted(Intercept e)

Parameters

e Intercept

RaisePropertyChanged(string?)

Invokes PropertyChanged to notify listeners that a property on this instance has changed.

protected virtual void RaisePropertyChanged(string? propertyName = null)

Parameters

propertyName string

The name of the property that changed.

Run() 

public void Run()

RunAsync(CancellationToken)

Connects to the remote interceptor and runs the packet processing loop.

public Task RunAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

RunAsync(GEarthConnectOptions, CancellationToken) 

public Task RunAsync(GEarthConnectOptions connectOpts = default, CancellationToken cancellationToken = default)

Parameters

connectOpts GEarthConnectOptions
cancellationToken CancellationToken

Returns

Task

Send(IPacket)

Sends a packet to the client or server, specified by the direction of the packet's header.

public void Send(IPacket packet)

Parameters

packet IPacket

SendInternal(Packet)

Sends the specified packet to G-Earth.

protected void SendInternal(Packet packet)

Parameters

packet Packet

Set<T>(ref T, T, string?)

Sets the value of the specified field and raises the PropertyChanged event, if the value was changed.

protected bool Set<T>(ref T field, T value, string? propertyName = null)

Parameters

field T

The backing field.

value T

The value to set the field to.

propertyName string

The name of the property used to access the backing field.

Returns

bool

true if the value of the field changed, otherwise false.

Type Parameters

T

The type of the field.

Stop() 

public void Stop()

Events

Activated

Occurs when the extension is selected in G-Earth's user interface.

public event Action? Activated

Event Type

Action

Connected

Occurs when a connection to the game is established.

public event Action<ConnectedEventArgs>? Connected

Event Type

Action<ConnectedEventArgs>

Disconnected

Occurs when a connection to the game ends.

public event Action? Disconnected

Event Type

Action

Initialized

Occurs when the interceptor has been initialized.

public event Action<InitializedEventArgs>? Initialized

Event Type

Action<InitializedEventArgs>

Intercepted

Occurs when a packet has been intercepted.

public event InterceptCallback? Intercepted

Event Type

InterceptCallback

PropertyChanged

Occurs when a property value changes.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler