diff options
| author | Aidan Skinner <aidan@apache.org> | 2008-04-16 12:18:33 +0000 |
|---|---|---|
| committer | Aidan Skinner <aidan@apache.org> | 2008-04-16 12:18:33 +0000 |
| commit | 4fc3409365cd3cda5c04a822a31b11a3239a3f1d (patch) | |
| tree | a75d97749134c6da88800efe9221b1bb837d0f41 /RC6/dotnet/Qpid.Messaging/IMessagePublisher.cs | |
| parent | 43a65de871e1854fa500c42af7386cc3db348fcd (diff) | |
| download | qpid-python-4fc3409365cd3cda5c04a822a31b11a3239a3f1d.tar.gz | |
QPID-916 tag RC6
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/tags/M2.1@648680 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'RC6/dotnet/Qpid.Messaging/IMessagePublisher.cs')
| -rw-r--r-- | RC6/dotnet/Qpid.Messaging/IMessagePublisher.cs | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/RC6/dotnet/Qpid.Messaging/IMessagePublisher.cs b/RC6/dotnet/Qpid.Messaging/IMessagePublisher.cs new file mode 100644 index 0000000000..d895a9749b --- /dev/null +++ b/RC6/dotnet/Qpid.Messaging/IMessagePublisher.cs @@ -0,0 +1,92 @@ +/* + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + * + */ +using System; + +namespace Apache.Qpid.Messaging +{ + /// <summary> + /// Defines an object capable of publishing messages + /// to an AMQP broker. + /// </summary> + /// <remarks> + /// A publisher can be created using either + /// <see cref="IChannel.CreatePublisher"/> or + /// using the builder pattern (preferred) with + /// <see cref="IChannel.CreatePublisherBuilder"/> + /// </remarks> + public interface IMessagePublisher : IDisposable, ICloseable + { + /// <summary> + /// Default delivery mode to use with this publisher + /// </summary> + DeliveryMode DeliveryMode { get; set; } + /// <summary> + /// Name of exchange messages are published to + /// </summary> + string ExchangeName { get; } + /// <summary> + /// Routing key used when publishing messages + /// </summary> + string RoutingKey { get; } + /// <summary> + /// If true, a message ID will not be generated by the publisher + /// when sending the message + /// </summary> + bool DisableMessageID { get; set; } + /// <summary> + /// If true, no timestamp will be added to the message + /// when publishing it + /// </summary> + bool DisableMessageTimestamp { get; set; } + /// <summary> + /// Default priority used when publishing messages + /// </summary> + int Priority { get; set; } + /// <summary> + /// Default time to live used when publishing messages + /// </summary> + long TimeToLive { get; set; } + /// <summary> + /// Set the default MIME type for messages produced by this producer. + /// This reduces the overhead of each message. + /// </summary> + string MimeType { get; set; } + /// <summary> + /// Set the default encoding for messages produced by this producer. + /// This reduces the overhead of each message. + /// </summary> + string Encoding { get; set; } + + /// <summary> + /// Publish a message, using any default values configured + /// </summary> + /// <param name="msg">Message to publish</param> + void Send(IMessage msg); + /// <summary> + /// Publish a message with the specified options + /// </summary> + /// <param name="msg">Message to publish</param> + /// <param name="deliveryMode">Delivery mode to use</param> + /// <param name="priority">Priority of the message</param> + /// <param name="timeToLive">Time to live of the message</param> + void Send(IMessage msg, DeliveryMode deliveryMode, int priority, long timeToLive); + } +} |
