BroField Class

BroField Class

Represents a BroValue with a field name as a column in a BroRecord. Implicitly castable to all BroType wrapper classes, structures and applicable .NET data types.

Inheritance Hierarchy

SystemObject
BroccoliSharpBroValue
BroccoliSharpBroField

Namespace: BroccoliSharp
Assembly: BroccoliSharp (in BroccoliSharp.dll) Version: 1.0.5434.15853

Syntax

JavaScript

Copy

public class BroField : BroValue, IEquatable<BroField>

Public Class BroField
	Inherits BroValue
	Implements IEquatable(Of BroField)

type BroField =  
    class
        inherit BroValue
        interface IEquatable<BroField>
    end

public class BroField extends BroValue implements IEquatable<BroField>

BroccoliSharp.BroField = function();

Type.createClass(
	'BroccoliSharp.BroField',
	BroccoliSharp.BroValue,
	IEquatable`1);

The BroField type exposes the following members.

Constructors

	Name	Description
	BroField(BroValue, String)	Creates a new BroField from the provided value and specified field name.
	BroField(Object, BroType, String, String)	Creates a new BroField from the provided value, type and specified field name.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current BroField. (Overrides BroValueEquals(Object).)
	Equals(BroField)	Indicates whether the current BroField is equal to another BroField of the same BroType.
	Equals(BroValue)	Indicates whether the current BroValue is equal to another BroValue of the same BroType. (Inherited from BroValue.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Gets a hash code for this BroField. (Overrides BroValueGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents this BroValue. (Inherited from BroValue.)

Top

Operators

	Name	Description
	Equality	Equality operator for BroField.
	(Boolean to BroField)	Implicitly converts Boolean value to a BroField.
	(DateTime to BroField)	Implicitly converts DateTime value to a BroField.
	(IPAddress to BroField)	Implicitly converts IPAddress value to a BroField.
	(String to BroField)	Implicitly converts String value to a BroField.
	(BroAddress to BroField)	Implicitly converts BroAddress value to a BroField.
	(BroPacket to BroField)	Implicitly converts BroPacket value to a BroField.
	(BroPort to BroField)	Implicitly converts BroPort value to a BroField.
	(BroRecord to BroField)	Implicitly converts BroRecord value to a BroField.
	(BroSet to BroField)	Implicitly converts BroSet value to a BroField.
	(BroString to BroField)	Implicitly converts BroString value to a BroField.
	(BroSubnet to BroField)	Implicitly converts BroSubnet value to a BroField.
	(BroTable to BroField)	Implicitly converts BroTable value to a BroField.
	(BroTime to BroField)	Implicitly converts BroTime value to a BroField.
	(BroVector to BroField)	Implicitly converts BroVector value to a BroField.
	Inequality	Inequality operator for BroField.

Top

Extension Methods

	Name	Description
	ConvertToType	Attempts to get a new BroValue based on the provided value converted to the specified type. (Defined by BroValueExtensions.)

Top

Properties

	Name	Description
	HasValue	Gets a flag that determines if this BroValue as an assigned value. (Inherited from BroValue.)
	Name	Gets or sets the name of this BroField.
	Type	Gets type of BroValue. (Inherited from BroValue.)
	TypeName	Gets or sets optional name of specialized type of BroValue. (Inherited from BroValue.)
	Value	Gets value of BroValue. (Inherited from BroValue.)

Top

Remarks

Name can be an empty string when source BroRecord represents a BroType.List.

Reference

BroccoliSharp Namespace