/*---------------------------------------------------------------------------* Project: Horizon File: socket_Berkeley.h Copyright (C)2010 Nintendo Co., Ltd. All rights reserved. These coded instructions, statements, and computer programs contain proprietary information of Nintendo of America Inc. and/or Nintendo Company Ltd., and are protected by Federal copyright law. They may not be disclosed to third parties or copied or duplicated in any form, in whole or in part, without the prior written consent of Nintendo. $Rev: 26646 $ *---------------------------------------------------------------------------*/ #ifndef NN_SOCKET_SOCKET_BERKLEY_H_ #define NN_SOCKET_SOCKET_BERKLEY_H_ #include #include #include #include /* IPC を介することによって返り値や引数が変わってしまうのを吸収する */ namespace nn { namespace socket { /*! @name ソケット @{ */ /*! @brief 新しいソケット記述子を作成します。 現在のバージョンでは少なくとも 8 個のソケットを同時に作成することができます。 @param[in] af @ref PF_INET を指定してください。 @param[in] type 作成するソケットの種類を指定します。 現時点では @ref SOCK_STREAM と @ref SOCK_DGRAM をサポートしています。 @param[in] protocol ソケットに用いるプロトコルを指定します。protocol が 0 の場合、 指定したプロトコルファミリとタイプに対するデフォルトのプロトコルが使われます。 現時点では 0 を指定してください。 @return 1以上 新しいソケット記述子。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EAFNOSUPPORT サポートされていないアドレスファミリ。 @return EPROTONOSUPPORT サポートされていないプロトコル。 @return EMFILE ソケット記述子をこれ以上作れません。 @return ENOMEM メモリ不足。 @return EPROTOTYPE サポートされていないソケットタイプ。 @see Close */ inline s32 Socket(s32 af, s32 type, s32 protocol) { s32 rval = 0; Result result = detail::Socket(&rval, af, type, protocol); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ストリームソケット ( @ref SOCK_STREAM ) を使って接続要求の受付を開始します。 @param[in] s ソケット記述子を指定します。@ref Socket によって作成したソケット記述子を指定して下さい。 @param[in] backlog ソケットのリッスンバックログキューに保持する未処理の接続の最大数を指定します。 backlogが 0 または負の場合、最大数は 1 に設定されます。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EOPNOTSUPP サポートされていない処理。 @return EINVAL 無効な処理。 @return ENOBUFS リソース不足。 @see Bind, Accept */ inline s32 Listen(s32 s, s32 backlog) { s32 rval = 0; Result result = detail::Listen(&rval, s, backlog); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief 着信を受付けます。 接続キューから最初の新しいソケットを接続を取り出し、指定したソケットと同じ ソケットタイプ、プロトコル、アドレスファミリーの新しいソケットを作成し、 新しいソケット記述子を返します。元のソケットはさらに接続要求を受け付けられる ようにそのまま残ります。 ソケット記述子が @ref Fcntl によって非封鎖モードに設定されていなければ、 Accept は未処理の接続がキューになければブロックします。 なお、取り出した新しいソケットの代わりにバックログを一つ確保しますが、メモリ不足 などでバックログが確保できなかった場合、着信の有無にかかわらず @ref ENOMEM を返します。 @param[in] s ソケット記述子を指定します。 @ref Socket によって作成し、 @ref Bindによってアドレスをバインドし、 @ref Listen の呼び出しに成功したソケット記述子を指定して下さい。 @param[out] sockAddr 受け付けた接続相手のソケットアドレスを記録するための ソケットアドレス構造体へのポインタを指定します。 @return 1以上 受け付けた接続のソケット記述子。 @return EINVAL 無効な処理。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EOPNOTSUPP サポートされていない処理。 @return ENOBUFS リソース不足。 @return EAGAIN O_NONBLOCK がソケット記述子に設定されていて、 かつ現在受け付けられる接続がありません。 @return ECONNABORTED 接続がキャンセルされました。 @return ENOMEM メモリ不足 @see Fcntl, GetPeerName, Listen */ inline s32 Accept(s32 s, SockAddrIn* sockAddr) { s32 rval = 0; Result result = detail::Accept(&rval, s, reinterpret_cast(sockAddr), sizeof(SockAddrIn)); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットにローカルソケットアドレスを割り当てます。 ローカルソケットアドレスは通信元のアドレスのことです。 @ref Socket で作成されたばかりのソケットは、いずれのアドレスにもバインドされません。
既ににバインド済みのソケット記述子を指定すると失敗します。 割り当てたローカルソケットアドレスは @GetSockName にて取得できます。 @param[in] s ソケット記述子を指定します。@ref Socket によって作成したソケット記述子を指定して下さい。 @param[in] sockAddr 割り当てるアドレス情報を保持しているソケットアドレス構造体 @ref SockAddrIn へのポインタを指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EOPNOTSUPP サポートされていない処理。 @return EINVAL 無効な処理。(ソケットがすでにアドレスにバインド済み、など) @return EAFNOSUPPORT サポートされていないアドレスファミリー。 @return EADDRINUSE アドレスがすでに使用中。 @see Socket, GetSockName */ inline s32 Bind(s32 s, const SockAddrIn* sockAddr) { s32 rval = 0; Result result = detail::Bind(&rval, s, reinterpret_cast(sockAddr), sizeof(SockAddrIn)); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief 指定したソケット記述子を使用し指定したリモートホストにへ接続を試みます。 @ref Bind によってソケットにローカルアドレスがバインドされていなかった場合、 @ref Connect によってソケットには使われていないローカルアドレスがバインドされます。
ソケットがストリームソケット ( @ref SOCK_STREAM ) の場合には通常は接続が確立するまで ブロックしますが、 @ref Fcntl によって非封鎖モードに設定されている場合には 可能な限り早く返ります。 この場合 @ref Poll によって接続の確立を調べることができます。 接続の確立に失敗した場合、まず Poll の返す値に POLLRDNORM と POLLWRNORM が立ちます。 接続の失敗は、続けて呼び出したデータ送信関数またはデータ受信関数がエラーを返すこと で知ることができます。
ソケットがデータグラムソケット ( @ref SOCK_DGRAM ) の場合には、データグラムの 送信先ソケットアドレスが変更されるだけですので、 封鎖モードと非封鎖モードでの動作に 違いはありません。 @param[in] s ソケット記述子を指定します。@ref Socket によって作成したソケット記述子を指定して下さい。 @param[in] sockAddr 通信先のアドレス情報を保持しているソケットアドレス構造体へのポインタを指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @see */ inline s32 Connect(s32 s, const SockAddrIn* sockAddr) { s32 rval = 0; Result result = detail::Connect(&rval, s, reinterpret_cast(sockAddr), sizeof(SockAddrIn)); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットを通じてリモートホストからデータ（メッセージ）の受信を試みます。 通常はソケットがメッセージを受信するまでブロックしますが、@ref Fcntl によって 非封鎖モードに設定されている場合、flags に MSG_DONTWAIT を 指定した場合には、 関数を呼び出した時点で受信されていたデータのみを取得し、ブロックしません。
データグラムソケット ( @ref SOCK_DGRAM ) では、メッセージ全体が単一処理で読み出されます。 メッセージが与えられたバッファに収まらず、flags に @ref MSG_PEEK が 指定されていない場合には、 超過した分のデータは破棄されます。
ストリームソケット ( @ref SOCK_STREAM ) では、メッセージ境界は無視されます。 この場合、データは利用可能になり次第ユーザーへ返ります。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] buf 受信データを読み出すバッファへのポインタを指定します。 @param[in] len 受信データを読み出すバッファのサイズをバイト単位で指定します。 @param[in] flags メッセージの伝達種別を指定します。 @param[out] sockFrom 通信先のアドレス情報を取得するソケットアドレス構造体へのポインタを指定します。 ソケットアドレスの len フィールドは適切に初期化 ( 例: sizeof( @ref SockAddrIn ) ) しておく必要があります。 @return 0 ストリームソケット ( @ref SOCK_STREAM ) では、リモートホストがメッセージの送信を終了したため これ以上メッセージの受信ができないことを示します。 データグラムソケット ( @ref SOCK_DGRAM ) では、0 は返りません。 1 以上 受信したメッセージのバイト数です。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EAGAIN O_NONBLOCK がソケット記述子に設定されていて(もしくは MSG_DONTWAIT が flags 指定されていて)、 受信を待つデータもしくは帯域外データがありません。 @return EINVAL 無効な処理。 @return EOPNOTSUPP サポートされていない処理。 @return ENOTCONN 接続されていません。 @return ECONNRESET 接続がリセットされました。 @return EINTR 中止されました。 @return ETIMEDOUT 時間切れ。 @return ENETDOWN ローカルネットワークインターフェースがダウンしています。 @see */ inline s32 RecvFrom(s32 s, void* buf, s32 len, s32 flags, SockAddrIn* sockFrom) { s32 rval; Result result; if (len <= detail::COPY_OR_MAP_THRESHOLD) { result = detail::RecvFromSmall(&rval, s, reinterpret_cast(buf), len, flags, reinterpret_cast(sockFrom), sizeof(SockAddrIn)); } else { result = detail::RecvFrom(&rval, s, reinterpret_cast(buf), len, flags, reinterpret_cast(sockFrom), sizeof(SockAddrIn)); } NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットを通じてリモートホストからデータ（メッセージ）の受信を試みます。 受信対象のホストを指定しない以外は @ref RecvFrom と同じです。 詳しくは @ref RecvFrom を参照してください。 @param[in] s @ref RecvFrom の説明を参照してください。 @param[in] buf @ref RecvFrom の説明を参照してください。 @param[in] len @ref RecvFrom の説明を参照してください。 @param[in] flags @ref RecvFrom の説明を参照してください。 @see RecvFrom */ inline s32 Recv(s32 s, void* buf, s32 len, s32 flags) { return RecvFrom(s, buf, len, flags, NULL); } /*! @brief ソケットを通じてリモートホストからデータ（メッセージ）の受信を試みます。 受信対象のホストとフラグを指定しない以外は @ref RecvFrom と同じです。 詳しくは @ref RecvFrom を参照してください。 @param[in] s @ref RecvFrom の説明を参照してください。 @param[in] buf @ref RecvFrom の説明を参照してください。 @param[in] len @ref RecvFrom の説明を参照してください。 @see RecvFrom */ inline s32 Read(s32 s, void* buf, s32 len) { return RecvFrom(s, buf, len, 0, NULL); } /*! @brief ソケットを通じてリモートホストへデータ（メッセージ）の送信を試みます。 通常はソケットの送信バッファにメッセージを格納するだけの空きが生じるまでブロックしますが、 @ref Fcntl によって非封鎖モードに設定されている場合、 flags に MSG_DONTWAIT を 指定した場合にはブロックしません。
データグラムソケット ( @ref SOCK_DGRAM ) では、メッセージ全体が単一処理で読み出されます。 メッセージが与えられたバッファに収まらず、flags に MSG_PEEK が 指定されていない場合には、 超過した分のデータは破棄されます。
ストリームソケット ( @ref SOCK_STREAM ) では、メッセージ境界は無視されます。 この場合、データは利用可能になり次第ユーザーへ返ります。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] buf 送信データを保持しているバッファへのポインタを指定します。 @param[in] len 送信するデータのサイズをバイト単位で指定します。 @param[in] flags メッセージの伝達種別を指定します。 @param[in] sockTo 通信先のアドレス情報を保持しているソケットアドレス構造体へのポインタを指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @see */ inline s32 SendTo(s32 s, const void* buf, s32 len, s32 flags, const SockAddrIn* sockTo) { s32 rval; Result result; if (len <= detail::COPY_OR_MAP_THRESHOLD) { result = detail::SendToSmall(&rval, s, reinterpret_cast(buf), len, flags, reinterpret_cast(sockTo), sizeof(SockAddrIn)); } else { result = detail::SendTo(&rval, s, reinterpret_cast(buf), len, flags, reinterpret_cast(sockTo), sizeof(SockAddrIn)); } NN_SOCKET_RETURN_IF_FAILED(result); return rval; } inline s32 SendToMulti(s32 s, const void* buf, s32 len, s32 flags, const SockAddrIn* sockTo, s32 saCount) { s32 rval; Result result; result = detail::SendToSmallMulti(&rval, s, reinterpret_cast(buf), len, flags, reinterpret_cast(sockTo), sizeof(SockAddrIn), sizeof(SockAddrIn) * saCount); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットを通じてリモートホストへデータ（メッセージ）の送信を試みます。 送信対象のホストを指定しない以外は @ref SendTo と同じです。 詳しくは @ref SendTo を参照してください。 @param[in] s @ref SendTo の説明を参照してください。 @param[in] buf @ref SendTo の説明を参照してください。 @param[in] len @ref SendTo の説明を参照してください。 @param[in] flags @ref SendTo の説明を参照してください。 @see SendTo */ inline s32 Send(s32 s, const void* buf, s32 len, s32 flags) { return SendTo(s, buf, len, flags, NULL); } /*! @brief ソケットを通じてリモートホストへデータ（メッセージ）の送信を試みます。 送信対象のホストとフラグを指定しない以外は @ref SendTo と同じです。 詳しくは @ref SendTo を参照してください。 @param[in] s @ref SendTo の説明を参照してください。 @param[in] buf @ref SendTo の説明を参照してください。 @param[in] len @ref SendTo の説明を参照してください。 @param[in] flags @ref SendTo の説明を参照してください。 @see SendTo */ inline s32 Write(s32 s, const void* buf, s32 len) { return SendTo(s, buf, len, 0, NULL); } /*! @brief ソケットを閉じます。閉じられたソケットは以後使用できなくなります。 閉じる対象となるソケットを用いた関数呼び出しがブロックされている場合、 ブロックは解除され、それぞれ所定のエラーを返します。
@ref Fcntl によって非封鎖モードに設定されていないストリームソケット ( SOCK_STREAM ) を 閉じる場合は、 @ref Linger オプション設定に従って接続が閉じられます。
デフォルトでは、Close はブロックせずすぐに処理を返します。 そして、バックグランドで残送信データを自動的に転送してからソケットが使用していたリソースを解放します。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return ENOTCONN 接続されていません。 @return EINVAL 無効な処理。 @see Socket, Fcntl, Shutdown */ inline s32 Close(s32 s) { s32 rval = 0; Result result = detail::Close(&rval, s); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットの送受信処理の一部もしくは全てを遮断します。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] how 遮断方法の種類を指定します。
- SHUT_RD 以降の受信処理を不可にします。
- SHUT_WR 以降の送信処理を不可にします。
- SHUT_RDWR 以降の送受信処理を不可にします。
@return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return ENOTCONN 接続されていません。 @return EINVAL 無効な処理。 @see */ inline s32 Shutdown(s32 s, s32 how) { s32 rval = 0; Result result = detail::Shutdown(&rval, s, how); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットの内部設定値や内部状態情報を取得します。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] level 対象のプロトコル層 @ref SocketLevel を指定します。 @param[in] optname 対象のオプション @ref SocketOptionType を指定します。 @param[out] optval 設定の格納先バッファを指定します。 @param[in,out] optlen optname に応じた optval のバッファ長を指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EINVAL 無効な処理。 @see SetSockOpt */ inline s32 GetSockOpt(s32 s, s32 level, int optname, void* optval, int* optlen) { s32 rval = 0; Result result = detail::GetSockOpt(&rval, s, level, optname, reinterpret_cast(optval), optlen); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットの内部設定値や内部状態情報を変更します。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] level 対象のプロトコル層 @ref SocketLevel を指定します。 @param[in] optname 対象のオプション @ref SocketOptionType を指定します。 @param[out] optval オプション情報を保持しているバッファへのポインタを指定します。 @param[in,out] optlen optname に応じた optval のバッファ長を指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EINVAL 無効な処理。 @see GetSockOpt */ inline s32 SetSockOpt(s32 s, s32 level, s32 optname, const void* optval, s32 optlen) { s32 rval = 0; Result result = detail::SetSockOpt(&rval, s, level, optname, reinterpret_cast(optval), optlen); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットの動作設定フラグを制御します。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] cmd 動作設定フラグの制御方法を指定します。
- F_GETFL - 動作設定フラグを読み出します。
- F_SETFL 動作設定フラグを変更します。
@param[in] val 制御方法により必要な追加の引数を指定します。 cmd が F_GETFL の場合は必要な追加引数はありませんので、 この引数は無視されます。 cmd が F_SETFL の場合は動作設定フラグを指定します。 0 もしくは以下の値の論理和です。
- O_NONBLOCK ソケットを非封鎖モードに設定します。 このフラグを設定しない場合にはソケットは封鎖モードになります。 なお、デフォルトではソケットは作成された時に封鎖モードに設定されます。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @see Accept, Connect, Recv, Send */ inline s32 Fcntl( s32 s, s32 cmd, s32 val ) { s32 rval = 0; Result result = detail::Fcntl(&rval, s, cmd, val); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief 複数のソケット記述子を指定し、その中に読み出しや書き込みが可能な状態のソケットがあるかを一度に調べます。 ソケットの状態変化を監視し、通常は指定した条件のソケットが見つかるまでブロックします。 指定した条件のソケットが見つからないままタイムアウト時間が過ぎた場合、 @ref Shutdown や @ref Close を使って ソケットの送受信処理を遮断する場合、ソケットになんらかの異常が検知された場合などにも ブロックが解除されます。 @param[in] fds 調査の対象となるソケット及び調査条件を指定し、調査結果を取得する @ref PollFd の配列を指定します。 @param[in] nfds fds で指定する配列の要素数を指定します。 @param[in] timeout ソケットが見つからない状態が続いた時のタイムアウト時間をミリ秒単位で指定します。 0 以上の値、もしくは以下の定数を指定して下さい。
- INFTIM タイムアウトしません。
@return 正の数 読み込みあるいは書き込み可能になったソケット記述子の数。 @return 0 呼び出しがタイムアウトしました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EINVAL 無効な処理。 @see */ inline s32 Poll( PollFd fds[], u32 nfds, s32 timeout ) { s32 rval = 0; Result result = detail::Poll(&rval, fds, nfds, timeout); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief 指定したソケットに帯域外データマークにあるかどうかを調べます。 ソケットの読み出し可能なバッファの先頭が TCP の緊急データの最後の 1 バイトかどうかを調べるために使用することができます。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @return 1 ソケットに帯域外のデータを受信したマークがされています。 当関数呼び出しに続けて MSG_OOB を指定した @ref Recv を呼び出すことで 帯域外のデータを読み出すことができます。 プロトコルが TCP の場合には、緊急データの最後の 1 バイトが 読み出し可能なバッファの先頭に存在することを示します。 @return 0 ソケットには帯域外のデータを受信したマークがされていません。 プロトコルが TCP の場合には、緊急データの存在は読み出し可能なバッファの先頭が TCP の緊急データの最後の 1 バイトになるまで検出できない点に注意して下さい。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EINVAL 無効な処理。 @see Recv, RecvFrom */ inline s32 SockAtMark( s32 s ) { s32 rval = 0; Result result = detail::SockAtMark(&rval, s); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief 自ホストのプライマリ IPv4 アドレスを取得します。 @return 0 通信が利用可能な状態ではありません。（自ホストに IPv4 アドレスが割り当てられていません。） @return 0 以外 ホストのプライマリ IPv4 アドレスをネットワークバイトオーダーの 32 ビット数値で返します。 @see */ inline u32 GetHostId( void ) { u32 rval = 0; detail::GetHostId(&rval); return rval; } /*! @brief ソケットのローカルアドレスを取得します。 ローカルアドレスは通信元のアドレスとして使用されます。 ローカルアドレスは @ref Bind, @ref Connect を呼び出すと確定します。 ローカルアドレスが確定されていない場合、TCP ソケットではエラーになります。 UDP ソケットでは、デフォルト値の 0.0.0.0 が取得できます。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] sockAddr バインドされたアドレス情報を取得するソケットアドレス構造体へのポインタを指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return EINVAL 無効な処理。 @see GetPeerName */ inline s32 GetSockName( s32 s, SockAddrIn* sockAddr ) { s32 rval = 0; Result result = detail::GetSockName(&rval, s, reinterpret_cast(sockAddr), sizeof(SockAddrIn)); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } /*! @brief ソケットのリモートアドレスを取得します。 リモートアドレスはソケットの通信先となるアドレスです。 @param[in] s ソケット記述子を指定します。@ref Socket もしくは @ref Accept によって作成したソケット記述子を指定して下さい。 @param[in] sockAddr 通信先のアドレス情報を取得するソケットアドレス構造体へのポインタを指定します。 @return 0 処理に成功しました。 @return ENETRESET ソケットライブラリが初期化されていません。 @return EBADF 不正なソケット記述子。 @return ENOTCONN 接続されていないか、前もって指定した相手がありませんでした。 @see GetSockName */ inline s32 GetPeerName( s32 s, SockAddrIn* sockAddr ) { s32 rval = 0; Result result = detail::GetPeerName(&rval, s, reinterpret_cast(sockAddr), sizeof(SockAddrIn)); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } inline s32 GetNetworkOpt( s32 level, s32 optname, void* optval, s32* optlen ) { s32 rval = 0; Result result = detail::GetNetworkOpt(&rval, level, optname, reinterpret_cast(optval), optlen); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } inline s32 GetResolverInfo( nn::socket::DnsServerInfo* pDnsServerInfo ) { s32 rval = 0; Result result = detail::GetResolverInfo(&rval, pDnsServerInfo); NN_SOCKET_RETURN_IF_FAILED(result); return rval; } // DnsUserClient /*! @brief ホストの名前を元に、ホストの情報を検索します。 DNS サーバに問い合わせを行う可能性があり、検索が完了するまでブロックします。 GetHostByName 関数は再入可能でもスレッドセーフでもありません。 複数のスレッドから呼び出す場合は @ref GetAddrInfo を使用して下さい。 @param[in] name ホスト名文字列、もしくはドット十進記法で IPv4 ホストアドレスを表現した 文字列へのポインタを指定します。 文字列は NULL で終端されている必要があります。 @return 処理に成功した場合は、ホストの情報を格納した @ref HostEnt 構造体へのポインタを返します。 構造体の実体はライブラリの内部バッファです。 処理に失敗した場合には NULL を返します。 @see GetHostByAddr, GetAddrInfo */ HostEnt* GetHostByName(const char8* name); /*! @brief ホストのアドレスを元に、ホストの情報を検索します。 DNS サーバに問い合わせを行う可能性があり、検索が完了するまでブロックします。 @param[in] addr len バイトの数値形式のホストアドレスを保持しているバッファへのポインタを指定します。 @param[in] len 数値形式のホストアドレスの長さ ( バイト単位 ) を指定します。 AF_INET では IP_ALEN を指定して下さい。 @param[in] type ホストアドレスのアドレスファミリーを指定します。 @ref AF_INET @return 処理に成功した場合は、ホストの情報を格納した @ref HostEnt 構造体へのポインタを返します。 構造体の実体はライブラリの内部バッファです。 処理に失敗した場合には NULL を返します。 @see GetHostByName, GetNameInfo */ HostEnt* GetHostByAddr(const void* addr, s32 len, s32 type); /*! @brief ホストのホスト名及びサービス名を元に、ホストの情報を検索します。 DNS サーバに問い合わせを行う可能性があり、検索が完了するまでブロックします。
検索結果を保持するバッファは、@ref Initialize で指定したワーク領域から新たに確保されます。 検索結果を解放するには @ref FreeAddrInfo を使用します。 @param[in] nodeName ホスト名文字列、もしくはドット十進記法で IPv4 ホストアドレスを表現した文字列へのポインタを指定します。 文字列は NULL で終端されている必要があります。 @param[in] servName サービス名文字列、もしくはポート番号を数値記法で表現した文字列へのポインタを指定します。 文字列は NULL で終端されている必要があります。 @param[in] hints 検索時の動作設定を行う @ref AddrInfo 構造体へのポインタを指定します。 @param[in] res 検索結果を格納される @ref AddrInfo へのポインタが格納される変数へのポインタを指定します。 @return 0 処理に成功しました。 @return EAI_FAIL 以下のいずれかの理由で処理できません。 - hints に指定したソケットの種類がサポートされていません。 - hints に指定したソケットのプロトコルがサポートされていません。 - hints に @ref AI_NUMERICHOST が指定されているにも関わらず nodeName をドット十進記法の文字列として解釈できません。 - hints に @ref AI_NUMERICSERV が指定されているにも関わらず servName を数値記法の文字列として解釈できません。 - nodeName に指定したホスト名の長さが @ref MAXDNAME を越えています。 - servName に指定したサービス名が既知のサービス名として解釈できません。 @return EAI_MEMORY 処理に必要なメモリを確保できません。 @return EAI_NONAME 検索対象のホストが見つかりません。 @see FreeAddrInfo */ s32 GetAddrInfo(const char8* nodeName, const char8* servName, const AddrInfo* hints, AddrInfo** res); /*! @brief @ref GetAddrInfo を使用してホスト情報を検索した際に 検索結果を保持するために確保されたバッファを解放します。 @param[in] head @ref GetAddrInfo によって得たホスト情報のリスト @ref AddrInfo の先頭への ポインタを指定します。 NULL ポインタを指定した場合は FreeAddrInfo 関数は何も処理を行いません。 @see GetAddrInfo */ void FreeAddrInfo(AddrInfo* head); /*! @brief ホストのアドレス情報を元に、ホスト名及びサービス名を検索します。 DNS サーバに問い合わせを行う可能性があり、検索が完了するまでブロックします。 @param[in] sa 検索するホストのアドレス情報を保持しているソケットアドレス構造体へのポインタを指定します。 @param[in] node ホスト名を取得するバッファへのポインタを指定します。 @param[in] nodeLen ホスト名を取得するバッファの大きさをバイト単位で指定します。 @param[in] service サービス名を取得するバッファへのポインタを指定します。 @param[in] serviceLen サービス名を取得するバッファの大きさをバイト単位で指定します。 @param[in] flags 検索時の動作設定フラグを指定します。0 もしくは以下の値の論理和です。 - NI_NOFQDN - 完全修飾ドメイン名 ( FQDN ) のうちノード名の部分だけをホスト名として取得します。 - NI_NUMERICHOST - ホスト名はソケットアドレス構造体に含まれているホストアドレスをドット十進記法による文字列に変換して取得します。 - NI_NAMEREQD - 検索対象のホストが見つからない場合に、数値形式のホストアドレスを文字列に変換することで代替せずにエラー ( SO_EAI_NONAME ) として扱います。 - NI_NUMERICSERV -サービス名はソケットアドレス構造体に含まれているサービス ( ポート番号 ) を数値記法による文字列に変換して取得します。 @return 0 処理に成功しました。 @return EAI_FAMILY sockAddr に指定したソケットアドレスに含まれるプロトコルファミリーがサポートされていません。 @return EAI_NONAME nodeLen 及び serviceLen に指定したバッファの大きさが不正であるか、 flags に NI_NAMEREQD を指定した呼び出しで検索対象のホストが見つかりません。 @see GetAddrInfo, GetHostByAddr */ s32 GetNameInfo(const void* sa, char8* node, s32 nodeLen, char8* service, s32 serviceLen, s32 flags); /*! @} @name バイトオーダ・アドレス変換 @{ */ // InetUtils /*! @brief ドット十進記法の IPv4 ホストアドレスを数値形式に変換します。 @ref Initialize を呼び出していなくても使用することができます。 @param[in] cp ドット十進記法で IPv4 アドレスを表現した文字列へのポインタを指定します。 文字列は NUL で終端されている必要があります。 @param[in] inp 数値形式のアドレスを取得する @ref InAddr へのポインタを指定します。 @return 1 処理に成功しました。 @return 0 cp に指定した文字列がドット十進記法で解釈できません。 @see InetNtoA, InetPtoN */ s32 InetAtoN(const char* cp, InAddr* inp); /*! @brief 数値形式の IPv4 ホストアドレスをドット十進記法の文字列に変換します。 @ref Initialize を呼び出していなくても使用することができます。
InetNtoA は再入可能でもスレッドセーフでもありません。 複数のスレッドから呼び出す場合は @ref InetNtoP を使用して下さい。 @param[in] in 数値形式の IPv4 ホストアドレスを保持する @ref InAddr を指定します @return 変換結果の文字列へのポインタを返します。 文字列の実体は静的に割り当てられたライブラリ内部のバッファです。 @see InetAtoN, InetNtoP */ char* InetNtoA(InAddr in); /*! @brief スタンダードテキスト表記のホストアドレスを数値形式に変換します。 @ref Initialize を呼び出していなくても使用することができます。 @param[in] af 変換するホストアドレスのアドレスファミリーを指定します。 @param[in] src スタンダードテキスト表記でホストアドレスを表現した文字列へのポインタを指定します。 文字列は NUL で終端されている必要があります。 - AF_INET @param[in] dst 数値形式のアドレスを取得する構造体へのポインタを指定します。 @ref AF_INET では、@ref InAddr へのポインタを指定して下さい。 @return 1 処理に成功しました。 @return 0 src に指定した文字列がスタンダードテキスト表記で解釈できません。 @return EAFNOSUPPORT サポートされていないアドレスファミリーです。 @see InetNtoP */ s32 InetPtoN(int af, const char* src, void* dst); /*! @brief 数値形式のホストアドレスをスタンダードテキスト表記の文字列に変換します。 @ref Initialize を呼び出していなくても使用することができます。 @param[in] af 変換するホストアドレスのアドレスファミリーを指定します。 - AF_INET @param[in] src 数値形式のホストアドレスを保持する構造体へのポインタを指定します。 @ref AF_INET では、@ref InAddr へのポインタを指定して下さい。 @param[in] dst スタンダードテキスト表記の文字列を取得するバッファへのポインタを指定します。 @ref AF_INET では、スタンダードテキスト表記はドット十進記法となります。 @param[in] len dst に指定するバッファの大きさをバイト単位で指定します。 AF_INET では、ドット十進記法の IPv4 ホストアドレス文字列の最大長 ( INET_ADDRSTRLEN ) のバッファを用意して下さい。 @return 処理に成功した場合は、変換結果の文字列へのポインタを返します。 文字列の実体は dst に指定したバッファです。 処理に失敗した場合には NULL を返します。 @see */ const char* InetNtoP(int af, const void* src, char* dst, unsigned len); // byteorder /*! @brief 32 ビットのホストバイトオーダーの値をネットワークバイトオーダーの値に変換します。 @param[in] v 32 ビットのホストバイトオーダーの値を指定します。 @return 32 ビットのネットワークバイトオーダーの値を返します。 @see NtoHl, HtoNs */ inline bit32 HtoNl(bit32 v) { return NN_SOCKET_HtoNl(v); } /*! @brief 32 ビットのネットワークバイトオーダーの値をホストバイトオーダーの値に変換します。 @param[in] v 32 ビットのネットワークバイトオーダーの値を指定します。 @return 32 ビットのホストバイトオーダーの値を返します。 @see HtoNl, NtoHs */ inline bit32 NtoHl(bit32 v) { return NN_SOCKET_NtoHl(v); } /*! @brief 16 ビットのホストバイトオーダーの値をネットワークバイトオーダーの値に変換します。 @param[in] v 16 ビットのホストバイトオーダーの値を指定します。 @return 16 ビットのネットワークバイトオーダーの値を返します。 @see NtoHs, HtoNl */ inline bit16 HtoNs(bit16 v) { return NN_SOCKET_HtoNs(v); } /*! @brief 16 ビットのネットワークバイトオーダーの値をホストバイトオーダーの値に変換します。 @param[in] v 16 ビットのネットワークバイトオーダーの値を指定します。 @return 16 ビットのホストバイトオーダーの値を返します。 @see HtoNs, NtoHl */ inline bit16 NtoHs(bit16 v) { return NN_SOCKET_NtoHs(v); } } } #endif // ifndef NN_SOCKET_SOCKET_BERKLEY_H_