mace::MaceKey_interface Class Reference

#include <MaceKey.h>

Inheritance diagram for mace::MaceKey_interface:

Collaboration diagram for mace::MaceKey_interface:

Detailed Description

The generic interface for MaceKey and its helper classes.

Definition at line 253 of file MaceKey.h.


Public Member Functions
virtual bool	isUnroutable () const =0
	Returns true if you cannot open a socket to the address.
virtual bool	isNullAddress () const =0
	Returns true if the address is "NULL".
virtual std::string	toHex () const =0
	Returns the address in a hexidecimal string format.
virtual std::string	addressString () const =0
	Returns the string in a canonical string format (IP address not hostname).
virtual bool	isBitArrMaceKey () const =0
	Return true if the address family is a bitstring family, currently SHA32 or SHA160.
virtual size_t	hashOf () const =0
	return an integer hash value for the MaceKey
virtual const MaceAddr &	getMaceAddr () const =0
	If an IPV4 MaceKey, returns the MaceAddr. Otherwise throws an exception.
virtual int	bitLength () const =0
	If a BitArr MaceKey, returns the length in bits, otherwise throws an exception.
virtual uint32_t	getNthDigit (int position, uint32_t digitBits=4) const =0
	Returns the digit of length `digitBits` at `position`.
virtual void	setNthDigit (uint32_t value, int position, uint32_t digitBits=4)=0
	Sets the digit at `position` of length `digitBits` to `value`.
virtual int	sharedPrefixLength (const MaceKey &key, uint32_t digitBits=4) const =0
	Returns the number of digits of length `digitBits` in common from the beginning of `key`.

The documentation for this class was generated from the following file: