mirror of
https://github.com/inthehand/32feet.git
synced 2026-10-22 00:45:03 +08:00
Peter Foot
108 lines
3.9 KiB
C#
108 lines
3.9 KiB
C#
// 32feet.NET - Personal Area Networking for .NET
|
|
//
|
|
// InTheHand.Net.Bluetooth.ServiceAttribute
|
|
//
|
|
// Copyright (c) 2003-2022 In The Hand Ltd, All rights reserved.
|
|
// This source code is licensed under the MIT License
|
|
|
|
using InTheHand.Net.Bluetooth.AttributeIds;
|
|
using System;
|
|
|
|
namespace InTheHand.Net.Bluetooth.Sdp
|
|
{
|
|
|
|
/// <summary>
|
|
/// Holds an attribute from an SDP service record.
|
|
/// </summary>
|
|
/// -
|
|
/// <remarks>
|
|
/// Access its SDP Data Element through the
|
|
/// <see cref="P:InTheHand.Net.Bluetooth.ServiceElement.Value"/> property and read the
|
|
/// data value through the methods and properties on the returned
|
|
/// <see cref="T:InTheHand.Net.Bluetooth.ServiceElement"/>.
|
|
/// </remarks>
|
|
#if CODE_ANALYSIS
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1711:IdentifiersShouldNotHaveIncorrectSuffix")]
|
|
#endif
|
|
public sealed class ServiceAttribute
|
|
{
|
|
//--------------------------------------------------------------
|
|
readonly ServiceAttributeId m_id;
|
|
readonly ServiceElement m_element;
|
|
|
|
//--------------------------------------------------------------
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="T:InTheHand.Net.Bluetooth.ServiceAttribute"/> class.
|
|
/// </summary>
|
|
/// -
|
|
/// <param name="id">The Attribute Id as a <see cref="T:InTheHand.Net.Bluetooth.ServiceAttributeId"/>.</param>
|
|
/// <param name="value">The value as a <see cref="T:InTheHand.Net.Bluetooth.ServiceElement"/>.</param>
|
|
public ServiceAttribute(ServiceAttributeId id, ServiceElement value)
|
|
{
|
|
m_id = id;
|
|
m_element = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="T:InTheHand.Net.Bluetooth.ServiceAttribute"/> class.
|
|
/// </summary>
|
|
/// -
|
|
/// <param name="id">The Attribute Id as a <see cref="T:System.UInt16"/>.</param>
|
|
/// <param name="value">The value as a <see cref="T:InTheHand.Net.Bluetooth.ServiceElement"/>.</param>
|
|
public ServiceAttribute(ushort id, ServiceElement value)
|
|
: this(unchecked((ServiceAttributeId)(Int16)id), value)
|
|
{ }
|
|
|
|
//--------------------------------------------------------------
|
|
|
|
/// <summary>
|
|
/// Get the Attribute Id for this attribute.
|
|
/// </summary>
|
|
/// -
|
|
/// <remarks>
|
|
/// <note >Id is a <em>unsigned</em> 32-bit integer but we use return it
|
|
/// is a <em>signed</em> 32-bit integer for CLS Compliance reasons. It
|
|
/// should not thus be used for ordering etc, for example 0xFFFF will sort
|
|
/// before 0x0001 which is backwards.
|
|
/// </note>
|
|
/// </remarks>
|
|
public ServiceAttributeId Id
|
|
{
|
|
[System.Diagnostics.DebuggerStepThrough]
|
|
get { return m_id; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get the Attribute Id as a number, e.g. for comparison.
|
|
/// </summary>
|
|
/// -
|
|
/// <remarks>
|
|
/// <para>Property <see cref="P:Id"/> should be used as an identifier,
|
|
/// but not as a number. That#x2019;s because the range is <em>unsigned</em>
|
|
/// 32-bit integer but we use return it is a <em>signed</em> 32-bit integer.
|
|
/// Thus an example list will sort as { 0xFFFF, 0x8001, 0x0001, 0x0302 }
|
|
/// when it should sort as { 0x0001, 0x0302, 0x8001,0xFFFF }
|
|
/// </para>
|
|
/// </remarks>
|
|
internal Int64 IdAsOrdinalNumber
|
|
{
|
|
get
|
|
{
|
|
var u32 = unchecked((UInt32)m_id);
|
|
return u32;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get the value of this attributes as a <see cref="T:InTheHand.Net.Bluetooth.ServiceElement"/>
|
|
/// </summary>
|
|
public ServiceElement Value
|
|
{
|
|
[System.Diagnostics.DebuggerStepThrough]
|
|
get { return m_element; }
|
|
}
|
|
|
|
}//class
|
|
}
|