AM Daemon ライブラリリファレンス
公開型 | 公開メンバ関数 | 静的公開メンバ関数 | 公開変数類 | 関連関数 | 全メンバ一覧
amdaemon::util::IpAddress 構造体
util : ユーティリティ | Network : ネットワーク

IPv4のIPアドレスを表す構造体。 [詳解]

#include <IpAddress.h>

公開型

typedef std::uint32_t value_type
 内部値の表現型。 [詳解]
 

公開メンバ関数

value_type getHostValue () const
 ホストバイトオーダーのIPアドレス直値を取得する。 [詳解]
 
value_type getOctet (std::size_t index) const
 オクテット値を取得する。 [詳解]
 
std::wstring toString () const
 文字列表現値を作成する。 [詳解]
 
IpAddress & operator&= (const IpAddress &r)
 ビット積代入演算子のオーバロード。 [詳解]
 
IpAddress & operator|= (const IpAddress &r)
 ビット和代入演算子のオーバロード。 [詳解]
 

静的公開メンバ関数

static IpAddress zero ()
 "0.0.0.0" のIPアドレス値を作成する。 [詳解]
 
static IpAddress make (value_type hostValue)
 ホストバイトオーダーのIPアドレス直値からIPアドレス値を作成する。 [詳解]
 
static bool canMake (value_type octet1, value_type octet2, value_type octet3, value_type octet4)
 IPアドレス値を作成可能な各オクテット値であるか否かを調べる。 [詳解]
 
static IpAddress make (value_type octet1, value_type octet2, value_type octet3, value_type octet4)
 各オクテット値からIPアドレス値を作成する。 [詳解]
 
static bool canMake (const wchar_t *address)
 IPアドレス値を作成可能なIPアドレス文字列であるか否かを調べる。 [詳解]
 
static IpAddress make (const wchar_t *address)
 IPアドレス文字列からIPアドレス値を作成する。 [詳解]
 

公開変数類

value_type value
 ネットワークバイトオーダーのIPアドレス直値。 [詳解]
 

関連関数

（これらはメソッドではありません）

IpAddress operator~ (const IpAddress &r)
 ビット反転演算子のオーバロード。 [詳解]
 
IpAddress operator& (const IpAddress &l, const IpAddress &r)
 ビット積演算子のオーバロード。 [詳解]
 
IpAddress operator| (const IpAddress &l, const IpAddress &r)
 ビット和演算子のオーバロード。 [詳解]
 
bool operator== (const IpAddress &l, const IpAddress &r)
 等価比較演算子のオーバロード。 [詳解]
 
bool operator!= (const IpAddress &l, const IpAddress &r)
 非等価比較演算子のオーバロード。 [詳解]
 
bool operator< (const IpAddress &l, const IpAddress &r)
 小なり比較演算子のオーバロード。 [詳解]
 
bool operator> (const IpAddress &l, const IpAddress &r)
 大なり比較演算子のオーバロード。 [詳解]
 
bool operator<= (const IpAddress &l, const IpAddress &r)
 小なり等価比較演算子のオーバロード。 [詳解]
 
bool operator>= (const IpAddress &l, const IpAddress &r)
 大なり等価比較演算子のオーバロード。 [詳解]
 

詳解

IPv4のIPアドレスを表す構造体。

覚え書き
memcpy 可能。

型定義メンバ詳解

typedef std::uint32_t amdaemon::util::IpAddress::value_type

内部値の表現型。

関数詳解

static IpAddress amdaemon::util::IpAddress::zero ( )
inlinestatic

"0.0.0.0" のIPアドレス値を作成する。

戻り値
"0.0.0.0" のIPアドレス値。
static IpAddress amdaemon::util::IpAddress::make ( value_type  hostValue)
static

ホストバイトオーダーのIPアドレス直値からIPアドレス値を作成する。

引数
[in]hostValueホストバイトオーダーのIPアドレス直値。
戻り値
作成されたIPアドレス値。
static bool amdaemon::util::IpAddress::canMake ( value_type  octet1,
value_type  octet2,
value_type  octet3,
value_type  octet4 
)
static

IPアドレス値を作成可能な各オクテット値であるか否かを調べる。

引数
[in]octet1第1オクテット値。 0 以上 255 以下。
[in]octet2第2オクテット値。 0 以上 255 以下。
[in]octet3第3オクテット値。 0 以上 255 以下。
[in]octet4第4オクテット値。 0 以上 255 以下。
戻り値
true作成可能である場合。
false作成不可能である場合。
参照
make(value_type, value_type, value_type, value_type)

この関数が true を返す場合、同じ引数を静的メンバ関数 make(value_type, value_type, value_type, value_type) に渡すことで、 例外を発生させることなくIPアドレス値を作成可能であることが保証される。

static IpAddress amdaemon::util::IpAddress::make ( value_type  octet1,
value_type  octet2,
value_type  octet3,
value_type  octet4 
)
static

各オクテット値からIPアドレス値を作成する。

引数
[in]octet1第1オクテット値。 0 以上 255 以下。
[in]octet2第2オクテット値。 0 以上 255 以下。
[in]octet3第3オクテット値。 0 以上 255 以下。
[in]octet4第4オクテット値。 0 以上 255 以下。
戻り値
作成されたIPアドレス値。
参照
canMake(value_type, value_type, value_type, value_type)
例外
Exceptionいずれかの引数に 255 よりも大きい値を指定した場合。
static bool amdaemon::util::IpAddress::canMake ( const wchar_t *  address)
static

IPアドレス値を作成可能なIPアドレス文字列であるか否かを調べる。

引数
[in]addressIPアドレス文字列。 "192.168.0.1" 等。
戻り値
true作成可能である場合。
false作成不可能である場合。
参照
make(const wchar_t*)

この関数が true を返す場合、同じ引数を静的メンバ関数 make(const wchar_t*) に渡すことで、 例外を発生させることなくIPアドレス値を作成可能であることが保証される。

static IpAddress amdaemon::util::IpAddress::make ( const wchar_t *  address)
static

IPアドレス文字列からIPアドレス値を作成する。

引数
[in]addressIPアドレス文字列。 "192.168.0.1" 等。
戻り値
作成されたIPアドレス値。
参照
canMake(const wchar_t*)
例外
Exception
  • 引数 address に nullptr を指定した場合。
  • 引数 address をIPアドレス値に変換できなかった場合。
value_type amdaemon::util::IpAddress::getHostValue ( ) const

ホストバイトオーダーのIPアドレス直値を取得する。

戻り値
ホストバイトオーダーのIPアドレス直値。
value_type amdaemon::util::IpAddress::getOctet ( std::size_t  index) const

オクテット値を取得する。

引数
[in]indexオクテットインデックス。 0 以上 3 以下。
戻り値
オクテット値。
例外
Exception引数 index に 4 以上の値を指定した場合。
std::wstring amdaemon::util::IpAddress::toString ( ) const

文字列表現値を作成する。

戻り値
文字列表現値。
IpAddress& amdaemon::util::IpAddress::operator&= ( const IpAddress &  r)
inline

ビット積代入演算子のオーバロード。

引数
[in]r右辺値。
戻り値
自身の参照。
IpAddress& amdaemon::util::IpAddress::operator|= ( const IpAddress &  r)
inline

ビット和代入演算子のオーバロード。

引数
[in]r右辺値。
戻り値
自身の参照。

フレンドと関連関数の詳解

IpAddress operator~ ( const IpAddress &  r)
related

ビット反転演算子のオーバロード。

引数
[in]r右辺値。
戻り値
演算結果値。
IpAddress operator& ( const IpAddress &  l,
const IpAddress &  r 
)
related

ビット積演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
演算結果値。
IpAddress operator| ( const IpAddress &  l,
const IpAddress &  r 
)
related

ビット和演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
演算結果値。
bool operator== ( const IpAddress &  l,
const IpAddress &  r 
)
related

等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator!= ( const IpAddress &  l,
const IpAddress &  r 
)
related

非等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。
bool operator< ( const IpAddress &  l,
const IpAddress &  r 
)
related

小なり比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。

ホストバイトオーダーでの大小を比較する。

bool operator> ( const IpAddress &  l,
const IpAddress &  r 
)
related

大なり比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。

ホストバイトオーダーでの大小を比較する。

bool operator<= ( const IpAddress &  l,
const IpAddress &  r 
)
related

小なり等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。

ホストバイトオーダーでの大小を比較する。

bool operator>= ( const IpAddress &  l,
const IpAddress &  r 
)
related

大なり等価比較演算子のオーバロード。

引数
[in]l左辺値。
[in]r右辺値。
戻り値
比較結果値。

ホストバイトオーダーでの大小を比較する。

メンバ詳解

value_type amdaemon::util::IpAddress::value

ネットワークバイトオーダーのIPアドレス直値。

この構造体詳解は次のファイルから抽出されました:
2018年07月31日(火) 15時54分15秒作成 - AM Daemon ライブラリリファレンス / 構成:   doxygen 1.8.11