Export (0) Print
Expand All

MessageQueue Members

MessageQueue overview

Public Constructors

public constructorMessageQueue Constructor Overloaded. Initializes a new instance of the MessageQueue class.

Public Fields

public fieldstatic (Shared in Visual Basic)InfiniteQueueSize Specifies that no size restriction exists for a queue.
public fieldstatic (Shared in Visual Basic)InfiniteTimeout Specifies that no time-out exists for methods that peek or receive messages.

Public Properties

public propertyAuthenticate Gets or sets a value indicating whether the queue accepts only authenticated messages.
public propertyBasePriority Gets or sets the base priority Message Queuing uses to route a public queue's messages over the network.
public propertyCanRead Gets a value indicating whether the MessageQueue can be read.
public propertyCanWrite Gets a value indicating whether the MessageQueue can be written to.
public propertyCategory Gets or sets the queue category.
public propertyContainer (inherited from Component) Gets the IContainer that contains the Component.
public propertyCreateTime Gets the time and date that the queue was created in Message Queuing.
public propertyDefaultPropertiesToSend Gets or sets the message property values to be used by default when the application sends messages to the queue.
public propertyDenySharedReceive Gets or sets a value indicating whether this MessageQueue has exclusive access to receive messages from the Message Queuing queue.
public propertystatic (Shared in Visual Basic)EnableConnectionCache Gets or sets a value indicating whether a cache of connections will be maintained by the application.
public propertyEncryptionRequired Gets or sets a value indicating whether the queue accepts only nonprivate (nonencrypted) messages.
public propertyFormatName Gets the unique queue name that Message Queuing generated at the time of the queue's creation.
public propertyFormatter Gets or sets the formatter used to serialize an object into or deserialize an object from the body of a message read from or written to the queue.
public propertyId Gets the unique Message Queuing identifier of the queue.
public propertyLabel Gets or sets the queue description.
public propertyLastModifyTime Gets the last time the properties of a queue were modified.
public propertyMachineName Gets or sets the name of the computer where the Message Queuing queue is located.
public propertyMaximumJournalSize Gets or sets the maximum size of the journal queue.
public propertyMaximumQueueSize Gets or sets the maximum size of the queue.
public propertyMessageReadPropertyFilter Gets or sets the property filter for receiving or peeking messages.
public propertyPath Gets or sets the queue's path. Setting the Path causes the MessageQueue to point to a new queue.
public propertyQueueName Gets or sets the friendly name that identifies the queue.
public propertyReadHandle Gets the native handle used to read messages from the message queue.
public propertySite (inherited from Component) Gets or sets the ISite of the Component.
public propertySynchronizingObject Gets or sets the object that marshals the event-handler call resulting from a ReceiveCompleted or PeekCompleted event.
public propertyTransactional Gets a value indicating whether the queue accepts only transactions.
public propertyUseJournalQueue Gets or sets a value indicating whether received messages are copied to the journal queue.
public propertyWriteHandle Gets the native handle used to send messages to the message queue.

Public Methods

public methodBeginPeek Overloaded. Initiates an asynchronous peek operation by telling Message Queuing to begin peeking a message and notify the event handler when finished.
public methodBeginReceive Overloaded. Initiates an asynchronous receive operation by telling Message Queuing to begin receiving a message and notify the event handler when finished.
public methodstatic (Shared in Visual Basic)ClearConnectionCache Clears the connection cache.
public methodClose Frees all resources allocated by the MessageQueue.
public methodstatic (Shared in Visual Basic)Create Overloaded. Creates a new queue at the specified path on a Message Queuing server.
public methodCreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
public methodstatic (Shared in Visual Basic)Delete Deletes a queue on a Message Queuing server.
public methodDispose (inherited from Component) Overloaded. Releases the resources used by the Component.
public methodEndPeek Completes the specified asynchronous peek operation.
public methodEndReceive Completes the specified asynchronous receive operation.
public methodEquals (inherited from Object) Overloaded. Determines whether two Object instances are equal.
public methodstatic (Shared in Visual Basic)Exists Determines whether a Message Queuing queue at the specified path exists.
public methodGetAllMessages Returns all the messages that are in the queue.
public methodGetEnumerator Enumerates the messages in a queue.
public methodGetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
public methodGetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
public methodstatic (Shared in Visual Basic)GetMachineId Gets the identifier of the computer on which the queue referenced by this MessageQueue is located.
public methodGetMessageEnumerator Creates an enumerator object for all the messages in the queue.
public methodstatic (Shared in Visual Basic)GetMessageQueueEnumerator Overloaded. Creates an enumerator object for a dynamic listing of the public queues on the network.
public methodstatic (Shared in Visual Basic)GetPrivateQueuesByMachine Retrieves all the private queues on the specified computer.
public methodstatic (Shared in Visual Basic)GetPublicQueues Overloaded. Retrieves all the public queues on the network.
public methodstatic (Shared in Visual Basic)GetPublicQueuesByCategory Retrieves all the public queues on the network that belong to the specified category.
public methodstatic (Shared in Visual Basic)GetPublicQueuesByLabel Retrieves all the public queues on the network that carry the specified label.
public methodstatic (Shared in Visual Basic)GetPublicQueuesByMachine Retrieves all the public queues that reside on the specified computer.
public methodGetType (inherited from Object) Gets the Type of the current instance.
public methodInitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
public methodPeek Overloaded. Returns a copy of the first message in the queue, without removing the message from the queue.
public methodPeekByCorrelationId Overloaded. Peeks a message that matches a given correlation identifier.
public methodPeekById Overloaded. Returns a copy of the message that has the specified message identifier, without removing the message from the queue.
public methodPurge Deletes all the messages contained in the queue.
public methodReceive Overloaded. Receives the first message in the queue, removing it from the queue.
public methodReceiveByCorrelationId Overloaded. Receives a message that matches a given correlation identifier.
public methodReceiveById Overloaded. Receives the message that matches the given identifier, removing it from the queue.
public methodRefresh Refreshes the properties presented by the MessageQueue to reflect the current state of the resource.
public methodResetPermissions Resets the permission list to the operating system's default values. Removes any queue permissions you have appended to the default list.
public methodSend Overloaded. Sends an object to a queue.
public methodSetPermissions Overloaded. Adds permissions to the current set. This controls who has access rights to queue properties and messages in the queue.
public methodToString (inherited from Object) Returns a String that represents the current Object.

Public Events

public eventDisposed (inherited from Component) Adds an event handler to listen to the Disposed event on the component.
public eventPeekCompleted Occurs when a message is read without being removed from the queue. This is a result of the asynchronous operation, BeginPeek.
public eventReceiveCompleted Occurs when a message has been removed from the queue. This event is raised by the asynchronous operation, BeginReceive.

Protected Properties

protected propertyDesignMode (inherited from Component) Gets a value that indicates whether the Component is currently in design mode.
protected propertyEvents (inherited from Component) Gets the list of event handlers that are attached to this Component.

Protected Methods

protected methodDispose Overloaded. Overridden. See Component.Dispose.
protected methodFinalize (inherited from Component) Overridden. Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.

In C# and C++, finalizers are expressed using destructor syntax.

protected methodGetService (inherited from Component) Returns an object that represents a service provided by the Component or by its Container.
protected methodMemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

MessageQueue Class | System.Messaging Namespace

Show:
© 2015 Microsoft