awips2/cotsSource/org.apache.qpid/dotnet/Qpid.Common/Framing/IContentHeaderProperties.cs
root e2ecdcfe33 Initial revision of AWIPS2 11.9.0-7p5
Former-commit-id: a02aeb236c [formerly 9f19e3f712] [formerly a02aeb236c [formerly 9f19e3f712] [formerly 06a8b51d6d [formerly 64fa9254b946eae7e61bbc3f513b7c3696c4f54f]]]
Former-commit-id: 06a8b51d6d
Former-commit-id: 8e80217e59 [formerly 3360eb6c5f]
Former-commit-id: 377dcd10b9
2012-01-06 08:55:05 -06:00

65 lines
2.5 KiB
C#

/*
*
* 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 Apache.Qpid.Buffer;
namespace Apache.Qpid.Framing
{
/// <summary>
/// There will be an implementation of this interface for each content type. All content types have associated
/// header properties and this provides a way to encode and decode them.
/// </summary>
public interface IContentHeaderProperties
{
/// <summary>
/// Writes the property list to the buffer, in a suitably encoded form.
/// </summary>
/// <param name="buffer">The buffer to write to</param>
void WritePropertyListPayload(ByteBuffer buffer);
/// <summary>
/// Populates the properties from buffer.
/// </summary>
/// <param name="buffer">The buffer to read from.</param>
/// <param name="propertyFlags">The property flags.</param>
/// <exception cref="AMQFrameDecodingException">Thrown when the buffer does not contain valid data</exception>
void PopulatePropertiesFromBuffer(ByteBuffer buffer, ushort propertyFlags);
/// <summary>
/// Gets the size of the encoded property list in bytes.
/// </summary>
/// <value>The size of the property list in bytes</value>
uint PropertyListSize
{
get;
}
/// <summary>
/// Gets the property flags. Property flags indicate which properties are set in the list. The
/// position and meaning of each flag is defined in the protocol specification for the particular
/// content type with which these properties are associated.
/// </summary>
/// <value>the flags as an unsigned integer</value>
ushort PropertyFlags
{
get;
}
}
}