IServiceBusService Interface

Defines a service bus for event-based messaging between disjoint systems.

Namespace: GSF.ServiceBus
Assembly: GSF.ServiceBus (in GSF.ServiceBus.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

[ServiceContractAttribute(SessionMode = SessionMode.Allowed, CallbackContract = typeof(IServiceBusServiceCallback))]
public interface IServiceBusService : ISelfHostingService, 
	IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings

<ServiceContractAttribute(SessionMode := SessionMode.Allowed, CallbackContract := GetType(IServiceBusServiceCallback))>
Public Interface IServiceBusService
	Inherits ISelfHostingService, IAdapter, ISupportLifecycle, IDisposable, 
	IProvideStatus, IPersistSettings

[ServiceContractAttribute(SessionMode = SessionMode::Allowed, CallbackContract = typeof(IServiceBusServiceCallback))]
public interface class IServiceBusService : ISelfHostingService, 
	IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings

[<ServiceContractAttribute(SessionMode = SessionMode.Allowed, CallbackContract = typeof(IServiceBusServiceCallback))>]
type IServiceBusService = 
    interface
        interface ISelfHostingService
        interface IAdapter
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
        interface IPersistSettings
    end

GSF.ServiceBus.IServiceBusService = function();
GSF.ServiceBus.IServiceBusService.createInterface('GSF.ServiceBus.IServiceBusService');

View Source

The IServiceBusService type exposes the following members.

Properties

	Name	Description
	ContractInterface	Gets or sets the FullName of the contract interface implemented by the web service. (Inherited from ISelfHostingService)
	Domain	Gets the AppDomain in which the IAdapter is executing. (Inherited from IAdapter)
	Enabled	Gets or sets a boolean value that indicates whether the object is enabled. (Inherited from ISupportLifecycle)
	Endpoints	Gets or sets a semicolon delimited list of URIs where the web service can be accessed. (Inherited from ISelfHostingService)
	HostFile	Gets or sets the path to the file where the IAdapter is housed. (Inherited from IAdapter)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from ISupportLifecycle)
	MemoryUsage	Gets the memory utilization of the IAdapter in bytes if executing in a separate AppDomain, otherwise NaN. (Inherited from IAdapter)
	Name	Gets the name of the object providing status information. (Inherited from IProvideStatus)
	PersistSettings	Determines whether the object settings are to be persisted to the config file. (Inherited from IPersistSettings)
	ProcessorUsage	Gets the % processor utilization of the IAdapter if executing in a separate AppDomain otherwise NaN. (Inherited from IAdapter)
	PublishMetadata	Gets or sets a boolean value that indicates whether web service metadata is to made available at all web service Endpoints. (Inherited from ISelfHostingService)
	SecurityPolicy	Gets or sets the FullName of IAuthorizationPolicy to be used for securing all web service Endpoints. (Inherited from ISelfHostingService)
	ServiceHost	Gets the ServiceHost hosting the web service. (Inherited from ISelfHostingService)
	SettingsCategory	Gets or sets the category name under which the object settings are persisted in the config file. (Inherited from IPersistSettings)
	Singleton	Gets or sets a boolean value that indicates whether the ServiceHost will use the current instance of the web service for processing requests or base the web service instance creation on InstanceContextMode specified in its ServiceBehaviorAttribute. (Inherited from ISelfHostingService)
	Status	Gets the current status details about object providing status information. (Inherited from IProvideStatus)
	TypeName	Gets or sets the text representation of the IAdapter's TypeName. (Inherited from IAdapter)

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
	GetClients	Gets a list of all clients connected to the ServiceBusService.
	GetLatestMessage	Gets the latest Message distributed to the subscribers of the specified topic.
	GetQueues	Gets a list of all Queues registered on the ServiceBusService.
	GetTopics	Gets a list of all Topics registered on the ServiceBusService.
	Initialize	Initializes the state of the object. (Inherited from ISupportLifecycle)
	LoadSettings	Loads saved settings from the config file. (Inherited from IPersistSettings)
	Publish	Sends the message to the ServiceBusService for distribution amongst its registered consumers.
	Register	Registers with the ServiceBusService to produce or consume Messages.
	SaveSettings	Saves settings to the config file. (Inherited from IPersistSettings)
	Unregister	Unregisters a previous registration with the ServiceBusService to produce or consume Messages

Top

Events

	Name	Description
	Disposed	Raised after the source object has been properly disposed. (Inherited from ISupportLifecycle)
	ExecutionException	Occurs when the IAdapter encounters an Exception during execution. (Inherited from IAdapter)
	ServiceHostCreated	Occurs when the ServiceHost has been created with the specified Endpoints. (Inherited from ISelfHostingService)
	ServiceHostStarted	Occurs when the ServiceHost can process requests via all of its endpoints. (Inherited from ISelfHostingService)
	ServiceProcessException	Occurs when an Exception is encountered when processing a request. (Inherited from ISelfHostingService)
	StatusUpdate	Occurs when the IAdapter wants to provide a status update. (Inherited from IAdapter)

Top

Reference

GSF.ServiceBus Namespace