// SNMP COUNTER32 type.
// Copyright (C) 2008-2010 Malcolm Crowe, Lex Li, and other contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
namespace GSF.Net.Snmp
{
///
/// Counter32 type.
///
public sealed class Counter32 : ISnmpData, IEquatable
{
private readonly uint _count;
private readonly byte[] _length;
private byte[] _raw;
///
/// Creates a instance from raw bytes.
///
///
internal Counter32(byte[] raw) : this(new Tuple(raw.Length, raw.Length.WritePayloadLength()), new MemoryStream(raw))
{
// IMPORTANT: for test project only.
}
///
/// Creates a with a specific .
///
/// Value
[CLSCompliant(false)]
public Counter32(uint value)
{
_count = value;
}
///
/// Initializes a new instance of the class.
///
/// The value.
public Counter32(long value)
{
_count = (uint)value;
}
///
/// Creates a instance from stream.
///
/// The length.
/// The stream.
public Counter32(Tuple length, Stream stream)
{
if (length == null)
{
throw new ArgumentNullException(nameof(length));
}
if (stream == null)
{
throw new ArgumentNullException(nameof(stream));
}
if (length.Item1 < 1 || length.Item1 > 5)
{
throw new ArgumentException("Byte length must between 1 and 5.", nameof(length));
}
_raw = new byte[length.Item1];
stream.Read(_raw, 0, length.Item1);
// TODO: improve here to read from stream directly.
if (length.Item1 == 5 && _raw[0] != 0)
{
throw new ArgumentException("If byte length is 5, then first byte must be 0.", nameof(length));
}
List list = new List(_raw);
list.Reverse();
while (list.Count > 4)
{
list.RemoveAt(list.Count - 1);
}
while (list.Count < 4)
{
list.Add(0);
}
_count = BitConverter.ToUInt32(list.ToArray(), 0);
_length = length.Item2;
}
#region ISnmpData Members
///
/// Type code.
///
public SnmpType TypeCode
{
get { return SnmpType.Counter32; }
}
///
/// Appends the bytes to .
///
/// The stream.
public void AppendBytesTo(Stream stream)
{
if (stream == null)
{
throw new ArgumentNullException(nameof(stream));
}
stream.AppendBytes(TypeCode, _length, GetRaw());
}
#endregion
///
/// Returns a that represents a .
///
/// A uint that represents the current object.
[CLSCompliant(false)]
public uint ToUInt32()
{
return _count;
}
///
/// Returns a that represents this .
///
/// A string that represents the current object.
public override string ToString()
{
return ToUInt32().ToString(CultureInfo.InvariantCulture);
}
///
/// Gets that raw bytes.
///
///
internal byte[] GetRaw()
{
return _raw ?? (_raw = ByteTool.GetRawBytes(BitConverter.GetBytes(_count), false));
}
///
/// Indicates whether the current object is equal to another object of the same type.
///
/// An object to compare with this object.
/// true if the current object is equal to the parameter; otherwise, false.
///
public bool Equals(Counter32 other)
{
return Equals(this, other);
}
///
/// Determines whether the specified is equal to the current .
///
/// The to compare with the current .
/// true if the specified is equal to the current ; otherwise, false.
///
public override bool Equals(object obj)
{
return Equals(this, obj as Counter32);
}
///
/// Serves as a hash function for a particular type.
///
/// A hash code for the current .
public override int GetHashCode()
{
return ToUInt32().GetHashCode();
}
///
/// The equality operator.
///
/// Left object
/// Right object
///
/// Returns true if the values of its operands are equal, false otherwise.
public static bool operator ==(Counter32 left, Counter32 right)
{
return Equals(left, right);
}
///
/// The inequality operator.
///
/// Left object
/// Right object
///
/// Returns true if the values of its operands are not equal, false otherwise.
public static bool operator !=(Counter32 left, Counter32 right)
{
return !(left == right);
}
///
/// The comparison.
///
/// Left object
/// Right object
///
/// Returns true if the values of its operands are not equal, false otherwise.
private static bool Equals(Counter32 left, Counter32 right)
{
object lo = left;
object ro = right;
if (lo == ro)
{
return true;
}
if (lo == null || ro == null)
{
return false;
}
return left.ToUInt32() == right.ToUInt32();
}
internal byte[] GetLengthBytes()
{
return _length;
}
}
}