MessageQueue Members

.NET Framework 3.0

Provides access to a queue on a Message Queuing server.

The following tables list the members exposed by the MessageQueue type.

  Name Description
Public method Supported by the .NET Compact Framework MessageQueue Overloaded. Initializes a new instance of the MessageQueue class.
Top

  Name Description
Public field Static Supported by the .NET Compact Framework InfiniteQueueSize Specifies that no size restriction exists for a queue.
Public field Static Supported by the .NET Compact Framework InfiniteTimeout Specifies that no time-out exists for methods that peek or receive messages.
Top

(see also Protected Properties )
  Name Description
Public property AccessMode Gets a value that indicates the access mode for the queue.
Public property Authenticate Gets or sets a value that indicates whether the queue accepts only authenticated messages.
Public property Supported by the .NET Compact Framework BasePriority Gets or sets the base priority Message Queuing uses to route a public queue's messages over the network.
Public property Supported by the .NET Compact Framework CanRead Gets a value that indicates whether the MessageQueue can be read.
Public property Supported by the .NET Compact Framework CanWrite Gets a value that indicates whether the MessageQueue can be written to.
Public property Supported by the .NET Compact Framework Category Gets or sets the queue category.
Public property Container  Gets the IContainer that contains the Component.(inherited from Component)
Public property Supported by the .NET Compact Framework CreateTime Gets the time and date that the queue was created in Message Queuing.
Public property Supported by the .NET Compact Framework DefaultPropertiesToSend Gets or sets the message property values to be used by default when the application sends messages to the queue.
Public property Supported by the .NET Compact Framework DenySharedReceive Gets or sets a value that indicates whether this MessageQueue has exclusive access to receive messages from the Message Queuing queue.
Public property Static Supported by the .NET Compact Framework EnableConnectionCache Gets or sets a value that indicates whether a cache of connections will be maintained by the application.
Public property EncryptionRequired Gets or sets a value that indicates whether the queue accepts only non-private (non-encrypted) messages.
Public property Supported by the .NET Compact Framework FormatName Gets the unique queue name that Message Queuing generated at the time of the queue's creation.
Public property Supported by the .NET Compact Framework Formatter 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 property Supported by the .NET Compact Framework Id Gets the unique Message Queuing identifier of the queue.
Public property Supported by the .NET Compact Framework Label Gets or sets the queue description.
Public property Supported by the .NET Compact Framework LastModifyTime Gets the last time the properties of a queue were modified.
Public property Supported by the .NET Compact Framework MachineName Gets or sets the name of the computer where the Message Queuing queue is located.
Public property Supported by the .NET Compact Framework MaximumJournalSize Gets or sets the maximum size of the journal queue.
Public property Supported by the .NET Compact Framework MaximumQueueSize Gets or sets the maximum size of the queue.
Public property Supported by the .NET Compact Framework MessageReadPropertyFilter Gets or sets the property filter for receiving or peeking messages.
Public property MulticastAddress Introduced in MSMQ 3.0. Gets or sets the multicast address associated with the queue.
Public property Supported by the .NET Compact Framework Path Gets or sets the queue's path. Setting the Path causes the MessageQueue to point to a new queue.
Public property Supported by the .NET Compact Framework QueueName Gets or sets the friendly name that identifies the queue.
Public property Supported by the .NET Compact Framework ReadHandle Gets the native handle used to read messages from the message queue.
Public property Supported by the .NET Compact Framework Site  Gets or sets the ISite of the Component.(inherited from Component)
Public property SynchronizingObject Gets or sets the object that marshals the event-handler call resulting from a ReceiveCompleted or PeekCompleted event.
Public property Supported by the .NET Compact Framework Transactional Gets a value that indicates whether the queue accepts only transactions.
Public property Supported by the .NET Compact Framework UseJournalQueue Gets or sets a value that indicates whether received messages are copied to the journal queue.
Public property Supported by the .NET Compact Framework WriteHandle Gets the native handle used to send messages to the message queue.
Top

  Name Description
Protected property CanRaiseEvents  Gets a value indicating whether the component can raise an event.(inherited from Component)
Protected property DesignMode  Gets a value that indicates whether the Component is currently in design mode.(inherited from Component)
Protected property Supported by the .NET Compact Framework Events  Gets the list of event handlers that are attached to this Component.(inherited from Component)
Top

(see also Protected Methods )
  Name Description
Public method Supported by the .NET Compact Framework BeginPeek Overloaded. Initiates an asynchronous peek operation by telling Message Queuing to begin peeking a message and notify the event handler when finished.
Public method Supported by the .NET Compact Framework BeginReceive Overloaded. Initiates an asynchronous receive operation by telling Message Queuing to begin receiving a message and notify the event handler when finished.
Public method Static Supported by the .NET Compact Framework ClearConnectionCache Clears the connection cache.
Public method Supported by the .NET Compact Framework Close Frees all resources allocated by the MessageQueue.
Public method Static Supported by the .NET Compact Framework Create Overloaded. Creates a new queue at the specified path on a Message Queuing server.
Public method CreateCursor Creates a new Cursor for the current message queue.
Public method CreateObjRef  Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (inherited from MarshalByRefObject)
Public method Static Supported by the .NET Compact Framework Delete Deletes a queue on a Message Queuing server.
Public method Supported by the .NET Compact Framework Dispose Overloaded. Disposes of the resources (other than memory) used by the MessageQueue.
Public method Supported by the .NET Compact Framework EndPeek Completes the specified asynchronous peek operation.
Public method Supported by the .NET Compact Framework EndReceive Completes the specified asynchronous receive operation.
Public method Supported by the .NET Compact Framework Equals  Overloaded. Determines whether two Object instances are equal. (inherited from Object)
Public method Static Supported by the .NET Compact Framework Exists Determines whether a Message Queuing queue exists at the specified path.
Public method Supported by the .NET Compact Framework GetAllMessages Returns all the messages that are in the queue.
Public method Supported by the .NET Compact Framework GetEnumerator Enumerates the messages in a queue. GetEnumerator is deprecated. GetMessageEnumerator2 should be used instead.
Public method Supported by the .NET Compact Framework GetHashCode  Serves as a hash function for a particular type. (inherited from Object)
Public method GetLifetimeService  Retrieves the current lifetime service object that controls the lifetime policy for this instance. (inherited from MarshalByRefObject)
Public method Static Supported by the .NET Compact Framework GetMachineId Gets the identifier of the computer on which the queue referenced by this MessageQueue is located.
Public method Supported by the .NET Compact Framework GetMessageEnumerator Creates an enumerator object for all the messages in the queue. GetMessageEnumerator is deprecated. GetMessageEnumerator2 should be used instead.
Public method GetMessageEnumerator2 Creates an enumerator object for all the messages in the queue.
Public method Static GetMessageQueueEnumerator Overloaded. Creates an enumerator object for a dynamic listing of the public queues on the network.
Public method Static Supported by the .NET Compact Framework GetPrivateQueuesByMachine Retrieves all the private queues on the specified computer.
Public method Static GetPublicQueues Overloaded. Retrieves all the public queues on the network.
Public method Static GetPublicQueuesByCategory Retrieves all the public queues on the network that belong to the specified category.
Public method Static GetPublicQueuesByLabel Retrieves all the public queues on the network that carry the specified label.
Public method Static GetPublicQueuesByMachine Retrieves all the public queues that reside on the specified computer.
Public method Static GetSecurityContext Retrieves the security context that MSMQ associates with the current user (thread identity) at the time of this call.
Public method Supported by the .NET Compact Framework GetType  Gets the Type of the current instance. (inherited from Object)
Public method InitializeLifetimeService  Obtains a lifetime service object to control the lifetime policy for this instance. (inherited from MarshalByRefObject)
Public method Supported by the .NET Compact Framework Peek Overloaded. Returns a copy of the first message in the queue without removing the message from the queue.
Public method Supported by the .NET Compact Framework PeekByCorrelationId Overloaded. Peeks a message that matches a given correlation identifier.
Public method Supported by the .NET Compact Framework PeekById Overloaded. Returns a copy of the message that has the specified message identifier without removing the message from the queue.
Public method PeekByLookupId Overloaded. Introduced in MSMQ 3.0. Peeks at a specific message from the queue. The message can be specified by a lookup identifier or by its position at the front or end of the queue.
Public method Supported by the .NET Compact Framework Purge Deletes all the messages contained in the queue.
Public method Supported by the .NET Compact Framework Receive Overloaded. Receives the first message in the queue, removing it from the queue.
Public method Supported by the .NET Compact Framework ReceiveByCorrelationId Overloaded. Receives a message that matches a given correlation identifier.
Public method Supported by the .NET Compact Framework ReceiveById Overloaded. Receives the message that matches the given identifier, removing it from the queue.
Public method ReceiveByLookupId Overloaded. Introduced in MSMQ 3.0. Receives a specific message from the queue. The message can be specified by a lookup identifier or by its position at the front or end of the queue.
Public method Static Supported by the .NET Compact Framework ReferenceEquals  Determines whether the specified Object instances are the same instance. (inherited from Object)
Public method Supported by the .NET Compact Framework Refresh Refreshes the properties presented by the MessageQueue to reflect the current state of the resource.
Public method ResetPermissions Resets the permission list to the operating system's default values. Removes any queue permissions you have appended to the default list.
Public method Supported by the .NET Compact Framework Send Overloaded. Sends an object to a queue.
Public method SetPermissions Overloaded. Adds permissions to the current set. This controls who has access rights to queue properties and messages in the queue.
Public method Supported by the .NET Compact Framework ToString  Returns a String containing the name of the Component, if any. This method should not be overridden. (inherited from Component)
Top

  Name Description
Protected method Supported by the .NET Compact Framework Dispose Overloaded. Overridden. Disposes of the resources (other than memory) used by the MessageQueue.
Protected method Supported by the .NET Compact Framework Finalize  Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (inherited from Component)
Protected method GetService  Returns an object that represents a service provided by the Component or by its Container. (inherited from Component)
Protected method Supported by the .NET Compact Framework MemberwiseClone  Overloaded. (inherited from MarshalByRefObject)
Top

  Name Description
Public event Supported by the .NET Compact Framework Disposed  Occurs when the component is disposed by a call to the Dispose method. (inherited from Component)
Public event Supported by the .NET Compact Framework PeekCompleted Occurs when a message is read without being removed from the queue. This is a result of the asynchronous operation, BeginPeek.
Public event Supported by the .NET Compact Framework ReceiveCompleted Occurs when a message has been removed from the queue. This event is raised by the asynchronous operation, BeginReceive.
Top
Show: