ITcHmiSrvExtAsyncHost Interface

Provides an interface to synchronously and asynchronously communicate with the TwinCAT HMI server.
All methods that do not end with Async are executed synchronously and block until the specific request has been sent to the TwinCAT HMI server and a corresponding response has been received.
The other methods that end with Async are executed asynchronously and do not block. Instead, they return a Task or TaskTResult that represents the asynchronous operation.

Namespace: TcHmiSrv.Core
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

public interface ITcHmiSrvExtAsyncHost

The ITcHmiSrvExtAsyncHost type exposes the following members.

Methods

	Name	Description
	DeleteConfigValue	Deletes a Value from the configuration of the TwinCAT HMI server extension.
	DeleteConfigValueAsync	Deletes a Value from the configuration of the TwinCAT HMI server extension as an asynchronous operation.
	Execute(Context, Command)	Executes a single Command in the domain of the specified Context.
	Execute(Context, CommandGroup)	Executes the specified CommandGroup inside any domain.
	ExecuteAsync(Context, Command)	Executes a single Command in the domain of the specified Context as an asynchronous operation.
	ExecuteAsync(Context, CommandGroup)	Executes the specified CommandGroup inside any domain as an asynchronous operation.
	GetConfigValue	Gets the configuration Value at the specified path.
	GetConfigValueAsync	Gets the configuration Value at the specified path as an asynchronous operation.
	Localize	Localizes an ILocalizable.
	LocalizeAsync	Localizes an ILocalizable as an asynchronous operation.
	NotifyListener	Sends a notification if an Alarm has changed.
	NotifyListenerAsync	Sends a notification if an Alarm has changed as an asynchronous operation.
	RegisterListener(Context, IListener)	Registers the specified IListener at the TwinCAT HMI server.
	RegisterListener(Context, String, IListener)	Registers the specified IListener at the TwinCAT HMI server for the specified domain.
	RegisterListener(Context, IListener, Value)	Registers the specified IListener at the TwinCAT HMI server using the specified settings.
	RegisterListener(Context, String, IListener, Value)	Registers the specified IListener at the TwinCAT HMI server for the specified domain using the specified settings.
	RegisterListenerAsync(Context, IListener)	Registers the specified IListener at the TwinCAT HMI server as an asynchronous operation.
	RegisterListenerAsync(Context, String, IListener)	Registers the specified IListener at the TwinCAT HMI server for the specified domain as an asynchronous operation.
	RegisterListenerAsync(Context, IListener, Value)	Registers the specified IListener at the TwinCAT HMI server using the specified settings as an asynchronous operation.
	RegisterListenerAsync(Context, String, IListener, Value)	Registers the specified IListener at the TwinCAT HMI server for the specified domain using the specified settings as an asynchronous operation.
	RemoveTemporaryEvent	Sends a notification if an Alarm should be removed.
	RemoveTemporaryEventAsync	Sends a notification if an Alarm should be removed as an asynchronous operation.
	RenameConfigValue	Renames a Value in the configuration of the TwinCAT HMI server extension.
	RenameConfigValueAsync	Renames a Value in the configuration of the TwinCAT HMI server extension as an asynchronous operation.
	ReplaceConfigValue	Replaces a Value in the configuration of the TwinCAT HMI server extension.
	ReplaceConfigValueAsync	Replaces a Value in the configuration of the TwinCAT HMI server extension as an asynchronous operation.
	ResetTemporaryEvents	Triggers a refresh of the list of events provided by a TwinCAT HMI server extension that implements the AlarmProviderListener.
	ResetTemporaryEventsAsync	Triggers a refresh of the list of events provided by a TwinCAT HMI server extension that implements the AlarmProviderListener as an asynchronous operation.
	Send(Context, Event)	Adds or updates an Event.
	Send(Context, Message)	Adds a Message.
	Send(Context, Event, EventLifetime)	Adds or updates an Event.
	Send(Context, Message, EventLifetime)	Adds a Message.
	SendAsync(Context, Event)	Adds or updates an Event as an asynchronous operation.
	SendAsync(Context, Message)	Adds a Message as an asynchronous operation.
	SendAsync(Context, Event, EventLifetime)	Adds or updates an Event as an asynchronous operation.
	SendAsync(Context, Message, EventLifetime)	Adds a Message as an asynchronous operation.
	SetConfigValue	Tries to add a Value to a map or vector in the configuration of the TwinCAT HMI server extension or update an existing configuration Value. Since the configuration Value is set asynchronously, you cannot rely on the Value really being set after this method returned. Therefore, you must verify this by using OnChange or calling GetConfigValue(Context, String). Obsolete
	SetConfigValueAsync	Tries to add a Value to a map or vector in the configuration of the TwinCAT HMI server extension or update an existing configuration Value as an asynchronous operation. Since the configuration Value is set asynchronously, you cannot rely on the Value really being set after this method returned. Therefore, you must verify this by using OnChange or calling GetConfigValueAsync(Context, String). Obsolete
	SetFriendlyName	Changes the friendly name of a TwinCAT HMI server extension.
	SetFriendlyNameAsync	Changes the friendly name of a TwinCAT HMI server extension as an asynchronous operation.
	TryLocalize	Tries to localize an ILocalizable.
	TryLocalizeAsync	Tries to localize an ILocalizable as an asynchronous operation.
	UnregisterListener	Unregisters the specified IListener at the TwinCAT HMI server. All registered IListeners are unregistered automatically when the extension is shut down.
	UnregisterListenerAsync	Unregisters the specified IListener at the TwinCAT HMI server as an asynchronous operation. All registered IListeners are unregistered automatically when the extension is shut down.

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core Namespace

Weiterführende Informationen

ITcHmiSrvExtAsyncHost Methods