GSF.ServiceBus
Represents information about a client connected to the to produce/consume s.
Gets or sets the session identifier of the client.
Gets or sets the UTC when the client connected to the .
Gets or sets the total number of s produced by the client.
Gets or sets the total number of s consumed by the client.
Gets or sets the object of the client.
Initializes a new instance of the class.
An object of the client.
Determines if the specified is equal to the current object.
The to compare with the current object.
true if both s are equal; otherwise false.
Gets a hash value for the current object.
An value.
Defines a service bus for event-based messaging between disjoint systems.
Registers with the to produce or consume s.
An containing registration data.
Unregisters a previous registration with the to produce or consume s
The used when registering.
Sends the to the for distribution amongst its registered consumers.
The that is to be distributed.
Gets the latest distributed to the subscribers of the specified .
The topic used when registering.
The latest distributed to the subscribers.
Gets a list of all clients connected to the .
An of objects.
Gets a list of all s registered on the .
An of objects.
Gets a list of all s registered on the .
An of objects.
Defines a callback contract that must be implemented by clients of for receiving s.
Invoked when a new is received from the .
received from the .
Indicates how a is distributed by the .
is distributed to all of its registered consumers.
is distributed to the first of all its registered consumers.
Represents a message that can be used to exchange information between processes using .
Gets or sets the when this was created.
Gets or sets the Type of this .
Gets or sets the identifier of this .
Gets or sets the format of the in this .
Gets or sets the actual payload of this .
Represents an authorization policy that can be used for enabling role-based security on .
This example shows the required config file entries when securing :
]]>
Gets the name of resource being accessed.
. property value for operations,
otherwise property value for all other operations.
Indicates how the distribution of s is processed by the .
distribution is processed in parallel for increased distribution performance.
distribution is processed sequentially to preserve ordering.
A service bus for event-based messaging between disjoint systems.
This example shows how to host inside a console application:
using System;
using System.ServiceModel;
using System.ServiceModel.Description;
using System.Threading;
using GSF;
using GSF.ServiceBus;
class Program
{
static void Main(string[] args)
{
// Prompt for security option.
Console.Write("Enable security (Y/N): ");
bool enableSecurity = Console.ReadLine().ParseBoolean();
// Initialize service bus.
ServiceBusService service = new ServiceBusService();
service.Singleton = true;
service.PublishMetadata = true;
service.PersistSettings = false;
service.Endpoints = "http.duplex://localhost:4501; net.tcp://locahost:4502";
if (enableSecurity)
service.SecurityPolicy = typeof(ServiceBusSecurityPolicy).FullName;
service.Initialize();
// Show service bus status.
if (service.ServiceHost.State == CommunicationState.Opened)
{
Console.WriteLine("\r\n{0} is running:", service.GetType().Name);
foreach (ServiceEndpoint endpoint in service.ServiceHost.Description.Endpoints)
{
Console.WriteLine("- {0} ({1})", endpoint.Address, endpoint.Binding.GetType().Name);
}
new Thread(delegate()
{
while (service.ServiceHost.State == CommunicationState.Opened)
{
Console.WriteLine();
Console.WriteLine();
Console.WriteLine("Status of {0}:", service.Name);
Console.WriteLine(service.Status);
Console.Write("Press Enter key to stop...");
Thread.Sleep(5000);
}
}).Start();
}
else
{
Console.WriteLine("\r\n{0} could not be started", service.GetType().Name);
}
// Shutdown.
Console.ReadLine();
service.Dispose();
}
}
This example shows how to host inside a web application:
]]>
This example shows how to publish s to :
using System;
using System.ServiceModel;
using System.Threading;
class Program : IServiceBusServiceCallback
{
static void Main(string[] args)
{
// NOTE: Service reference to the service bus service must be added to generate the service proxy.
// Initialize auto-generated service bus service proxy.
InstanceContext callbackContext = new InstanceContext(new Program());
ServiceBusServiceClient serviceBusService = new ServiceBusServiceClient(callbackContext, "NetTcpBinding_IServiceBusService");
// Create registration request for publishing messages.
RegistrationRequest registration = new RegistrationRequest();
registration.MessageType = MessageType.Topic;
registration.MessageName = "Topic.Frequency";
registration.RegistrationType = RegistrationType.Produce;
serviceBusService.Register(registration);
// Start publishing messages to the bus asynchronously.
new Thread(delegate()
{
Message message = new Message();
message.Type = registration.MessageType;
message.Name = registration.MessageName;
message.Format = "application/octet-stream";
Random random = new Random(59);
while (serviceBusService.State == CommunicationState.Opened)
{
message.Time = DateTime.UtcNow;
message.Content = BitConverter.GetBytes(random.Next(61));
serviceBusService.Publish(message);
Thread.Sleep(5000);
}
}).Start();
// Shutdown.
Console.Write("Press Enter key to stop...");
Console.ReadLine();
serviceBusService.Close();
}
public void ProcessMessage(Message message)
{
// This method will not be invoked since we are not consuming messages.
throw new NotSupportedException();
}
}
This example shows how to subscribe to for receiving s:
using System;
using System.ServiceModel;
class Program : IServiceBusServiceCallback
{
static void Main(string[] args)
{
// NOTE: Service reference to the service bus service must be added to generate the service proxy.
// Initialize auto-generated service bus service proxy.
InstanceContext callbackContext = new InstanceContext(new Program());
ServiceBusServiceClient serviceBusService = new ServiceBusServiceClient(callbackContext, "NetTcpBinding_IServiceBusService");
// Subscribe with service bus service to receive messages.
RegistrationRequest registration = new RegistrationRequest();
registration.MessageType = MessageType.Topic;
registration.MessageName = "Topic.Frequency";
registration.RegistrationType = RegistrationType.Consume;
serviceBusService.Register(registration);
// Shutdown.
Console.WriteLine("Press Enter key to stop...");
Console.WriteLine();
Console.ReadLine();
serviceBusService.Close();
}
public void ProcessMessage(Message message)
{
if (message.Format != "application/octet-stream")
Console.WriteLine("Message format '{0}' is not supported", message.Format);
else
Console.WriteLine("Message received: {0} Hz", BitConverter.ToInt32(message.Content, 0));
}
}
This example shows how to monitor remotely:
using System;
using System.ServiceModel;
using System.Threading;
using GSF;
class Program : IServiceBusServiceCallback
{
static void Main(string[] args)
{
// NOTE: Service reference to the service bus service must be added to generate the service proxy.
// Initialize auto-generated service bus service proxy.
InstanceContext callbackContext = new InstanceContext(new Program());
ServiceBusServiceClient serviceBusService = new ServiceBusServiceClient(callbackContext, "NetTcpBinding_IServiceBusService");
serviceBusService.ChannelFactory.Open();
// Start querying service bus service status asynchronously.
new Thread(delegate()
{
while (serviceBusService.State == CommunicationState.Opened)
{
Console.Clear();
Console.WriteLine(new string('-', 79));
Console.WriteLine("|" + "Service Bus Status".CenterText(77) + "|");
Console.WriteLine(new string('-', 79));
Console.WriteLine();
// Show clients.
Console.Write("Client ID".PadRight(25));
Console.Write(" ");
Console.Write("Connected".PadRight(21));
Console.Write(" ");
Console.Write("Msg. Produced".PadRight(15));
Console.Write(" ");
Console.Write("Msg. Consumed".PadRight(15));
Console.WriteLine();
Console.Write(new string('-', 25));
Console.Write(" ");
Console.Write(new string('-', 21));
Console.Write(" ");
Console.Write(new string('-', 15));
Console.Write(" ");
Console.Write(new string('-', 15));
Console.WriteLine();
foreach (ClientInfo client in serviceBusService.GetClients())
{
Console.Write(client.SessionId.TruncateRight(25).PadRight(25));
Console.Write(" ");
Console.Write(client.ConnectedAt.ToString("MM/dd/yy hh:mm:ss tt").PadRight(21));
Console.Write(" ");
Console.Write(client.MessagesProduced.ToString().PadRight(15));
Console.Write(" ");
Console.Write(client.MessagesConsumed.ToString().PadRight(15));
Console.WriteLine();
}
Console.WriteLine();
// Show queues.
Console.Write("Queue Name".PadRight(25));
Console.Write(" ");
Console.Write("Producers".PadRight(10));
Console.Write(" ");
Console.Write("Consumers".PadRight(10));
Console.Write(" ");
Console.Write("Msg. Received".PadRight(15));
Console.Write(" ");
Console.Write("Msg. Processed".PadRight(15));
Console.WriteLine();
Console.Write(new string('-', 25));
Console.Write(" ");
Console.Write(new string('-', 10));
Console.Write(" ");
Console.Write(new string('-', 10));
Console.Write(" ");
Console.Write(new string('-', 15));
Console.Write(" ");
Console.Write(new string('-', 15));
Console.WriteLine();
foreach (RegistrationInfo queue in serviceBusService.GetQueues())
{
Console.Write(queue.MessageName.PadRight(25));
Console.Write(" ");
Console.Write(queue.Producers.Length.ToString().PadRight(15));
Console.Write(" ");
Console.Write(queue.Consumers.Length.ToString().PadRight(15));
Console.Write(" ");
Console.Write(queue.MessagesReceived.ToString().PadRight(15));
Console.Write(" ");
Console.Write(queue.MessagesProcessed.ToString().PadRight(15));
Console.WriteLine();
}
Console.WriteLine();
// Show topics.
Console.Write("Topic Name".PadRight(25));
Console.Write(" ");
Console.Write("Producers".PadRight(10));
Console.Write(" ");
Console.Write("Consumers".PadRight(10));
Console.Write(" ");
Console.Write("Msg. Received".PadRight(15));
Console.Write(" ");
Console.Write("Msg. Processed".PadRight(15));
Console.WriteLine();
Console.Write(new string('-', 25));
Console.Write(" ");
Console.Write(new string('-', 10));
Console.Write(" ");
Console.Write(new string('-', 10));
Console.Write(" ");
Console.Write(new string('-', 15));
Console.Write(" ");
Console.Write(new string('-', 15));
Console.WriteLine();
foreach (RegistrationInfo topic in serviceBusService.GetTopics())
{
Console.Write(topic.MessageName.PadRight(25));
Console.Write(" ");
Console.Write(topic.Producers.Length.ToString().PadRight(15));
Console.Write(" ");
Console.Write(topic.Consumers.Length.ToString().PadRight(15));
Console.Write(" ");
Console.Write(topic.MessagesReceived.ToString().PadRight(15));
Console.Write(" ");
Console.Write(topic.MessagesProcessed.ToString().PadRight(15));
Console.WriteLine();
}
Console.WriteLine();
Console.Write("Press Enter key to stop...");
Thread.Sleep(5000);
}
}).Start();
// Shutdown.
Console.ReadLine();
serviceBusService.Close();
}
public void ProcessMessage(Message message)
{
// This method will not be invoked since we are not consuming messages.
throw new NotSupportedException();
}
}
Specifies the default value for the property.
Specifies the default value for the property.
Initializes a new instance of the class.
Initializes the .
The specified is not supported.
Saves settings to the config file if the property is set to true.
Loads saved settings from the config file if the property is set to true.
Registers with the to produce or consume s.
An containing registration data.
Unregisters a previous registration with the to produce or consume s
The used when registering.
Sends the to the for distribution amongst its registered consumers.
The that is to be distributed.
Gets the latest distributed to the subscribers of the specified .
The topic used when registering.
The latest distributed to the subscribers.
Gets a list of all clients connected to the .
An of objects.
Gets a list of all s registered on the .
An of objects.
Gets a list of all s registered on the .
An of objects.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Gets or sets a boolean value that indicates whether the is currently enabled.
Gets the descriptive status of the .
Gets or sets the maximum number of s that can be buffered for distribution by the before the
the oldest buffered s are discarded to keep memory consumption in check by avoiding flooding.
Set to -1 to disable discarding of s.
Gets or sets the used by the for processing distribution.
Contains WCF web services that facilitate secure inter-process messaging.
Represents information about a registration with the to produce/consume s.
Gets or sets the type for s being produced/consumed.
Gets or sets the name for s being produced/consumed.
Gets or sets the total number of s received.
Gets or sets the total number of s distributed.
Gets or sets the list of clients producing the s.
Gets or sets the list of clients consuming the s.
Gets or sets the latest distributed to the subscribers.
Gets the to be used for synchronized access to .
Gets the to be used for synchronized access to .
Initializes a new instance of the class.
An object.
Releases the unmanaged resources before the object is reclaimed by .
Releases all the resources used by the object.
Releases the unmanaged resources used by the object and optionally releases the managed resources.
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Indicates the intent of the .
Register to produce s.
Register to consume s.
Represents a request to register with the to produce or consume s.
Gets or sets the type of this .
Gets or sets the of the this is for.
Gets or sets the of the this is for.