Microsoft.SqlServer.Management.Smo.Broker Namespace

The Microsoft.SqlServer.Management.Smo.Broker namespace contains classes that represent the Service Broker items that you can manage by using SQL Server Management Objects.

Classes

BrokerObjectBase

The BrokerObjectBase class is a base class that is inherited by other Service Broker classes.

BrokerPriority

The BrokerPriority object represents a priority level and the set of criteria for determining which Service Broker conversations to assign the priority level.

BrokerPriorityCollection

The BrokerPriorityCollection class represents a collection of BrokerPriority objects that represent all the conversation priorities defined on a database.

BrokerPriorityExtender

Exposes Service Broker conversation priority methods and properties in addition to the methods and properties of the BrokerPriority object.

BrokerService

The BrokerService object represents a Service Broker service, which is an addressable endpoint for conversations.

BrokerServiceCollection

The BrokerServiceCollection class represents a collection of BrokerService objects that represent all the Service Broker services defined on a database.

BrokerServiceEvents

The BrokerServiceEvents object represents the settings required for Service Broker service event notification.

BrokerServiceExtender

Exposes Service Broker service methods and properties in addition to the methods and properties of the BrokerService object.

MessageType

The MessageType object represents a message type that defines the content of messages.

MessageTypeCollection

The MessageTypeCollection class represents a collection of MessageType objects that represent all the message types defined on a database.

MessageTypeEvents

The MessageTypeEvents object represents the settings required for SQL Server message type event notification.

MessageTypeExtender

Exposes Service Broker message type methods and properties in addition to the methods and properties of the MessageType object.

MessageTypeMapping

The MessageTypeMapping object represents a relationship between message types and a contract.

MessageTypeMappingCollection

The MessageTypeMappingCollection class represents a collection of MessageTypeMapping objects that represent all the message types defined on a contract.

RemoteServiceBinding

The RemoteServiceBinding object represents the settings that Service Broker uses for security and authentication when communicating with a remote service.

RemoteServiceBindingCollection

The RemoteServiceBindingCollection class represents a collection of RemoteServiceBinding objects that represent all the remote service bindings defined on a database.

RemoteServiceBindingEvents

The RemoteServiceBindingEvents object represents the settings required for Microsoft SQL Server remote service binding event notification.

RemoteServiceBindingExtender

Exposes Service Broker remote service binding methods and properties in addition to the methods and properties of the RemoteServiceBinding object.

ServiceBroker

The ServiceBroker object represents an implementation of Service Broker on a Microsoft SQL Server database.

ServiceContract

The ServiceContract objects represents a contract that specifies the direction and type of messages in a conversation.

ServiceContractCollection

The ServiceContractCollection class represents a collection of ServiceContract objects that represent all the service contracts defined on a database.

ServiceContractEvents

The ServiceContractEvents object represents the settings required for SQL Server service contract event notification.

ServiceContractExtender

Exposes Service Broker contract methods and properties in addition to the methods and properties of the ServiceContract object.

ServiceContractMapping

The ServiceContractMapping class represents the service contracts that are associated with the Service Broker service.

ServiceContractMappingCollection

The ServiceContractMappingCollection class represents a collection of ServiceContractMapping objects that represent all the message types defined on a contract.

ServiceQueue

The ServiceQueue object represents a queue that stores Service Broker messages.

ServiceQueueCollection

The ServiceQueueCollection class represents a collection of ServiceQueue objects that represent all the service queues defined on a database.

ServiceQueueEvents

The ServiceQueueEvents object represents the settings required for SQL Server service queue event notification.

ServiceQueueExtender

Exposes Service Broker queue methods and properties in addition to the methods and properties of the ServiceQueue object.

ServiceRoute

The ServiceRoute object represents a Service Broker route that contains the location information for the service and the database on which it is defined.

ServiceRouteCollection

The ServiceRouteCollection class represents a collection of ServiceRoute objects that represent all the service routes defined on a database.

ServiceRouteEvents

The ServiceRouteEvents object represents the settings required for SQL Server service route event notification.

ServiceRouteExtender

Exposes Service Broker route methods and properties in addition to the methods and properties of the ServiceRoute object.

Enums

DialogEndPointState

The DialogEndPointState enumeration contains constant values that specify the state of the endpoint at the service.

DialogType

The DialogType enumeration contains constant values that specify the type of dialog between Service Broker endpoints.

MessageSource

The MessageSource enumeration contains constant values that specify which endpoint sent the message.

MessageTypeValidation

The MessageTypeValidation enumeration contains constant values that specify the types of validation performed on the Service Broker message body.

Remarks

After a connection to an instance of SQL Server has been established by using the Server object variable, you can use the objects in the Microsoft.SqlServer.Management.Smo.Broker namespace to manage the Service Broker.

The Microsoft.SqlServer.Management.Smo.Broker namespace resides in the Microsoft.SqlServer.Smo.dll assembly file. Also, some of the enumeration classes are in the Microsoft.SqlServer.ServiceBrokerEnum.dll assembly file. You will have to import both files to access the classes in the Microsoft.SqlServer.Management.Smo.Broker namespace.

By using the Microsoft.SqlServer.Management.Smo.Broker namespace you can do the following:

  • View and modify Service Broker settings.

  • Create, alter, and drop Service Broker objects.

  • Manage Service Broker queues, routes, message types, contracts, service bindings, and priorities.

  • Set up, manage, and handle Service Broker events.