NSDServerInfo メンバ

サーバー用クラス。


●コンストラクタ

名前 説明
NSDServerInfo NSDServerInfoを初期化します。

●プロパティの一覧

名前 説明
PortNo ポート番号を設定します。
ServerState サーバーの状態を返します。
SocketConnectLoginTimeOut ログインタイムアウトを設定します。
DataSocketConnectTimeOut データ用ソケットに接続されるまでの時間を設定します。
LoginNameCheckCount ログイン名の確認でリトライができる最大数を設定します。
PasswordCheckCount パスワードの確認でリトライができる最大数を設定します。
UserFileName ユーザー定義ファイル名を設定します。
StdFolder 基準フォルダーを設定します。

●メソッドの一覧

名前 引数 戻り値 説明
Dispose なし なし リソースの解放を行います。
※終了時に必ず呼び出します。
Listen なし Boolean型 クライアントからの受信待ちを行います。
( Integer ) Boolean型 クライアントからの受信待ちを行います。
ListenEnd なし なし 受信待ちを終了します。
CloseClient ( NSDReceive ) なし 指定クライアントを切断します。
CloseClientAll なし なし 全てのクライアントを切断します。
IsAddOkUserList ( NSDUserInfo ) ERR_KIND ユーザーリストに追加可能ユーザーかを確認します。
AddUserList ( NSDUserInfo ) ERR_KIND ユーザーリストにユーザーを追加します。
ChangeUserList ( NSDUserInfo ) ERR_KIND ユーザーリストのユーザーを変更します。
DeleteUserList ( NSDUserInfo ) ERR_KIND ユーザーリストからユーザーを削除します。
GetUserList なし ArrayList ユーザーリストを返します。
GetUserCount なし Integer ユーザーの件数を返します。
GetUserToUserList ( Integer , NSDUserInfo ) ERR_KIND ユーザーリストから指定ユーザー情報を取得します。
ReadUserList ( String ) Boolean型 ユーザーリストをファイルから読み込みます。
WriteUserList ( String ) Boolean型 ユーザーリストをファイルに書き込みます。
IsOkLoginNameString ( String ) ERR_KIND ログイン名の確認を行います。
GetLoginOkStringMsg なし String ログインで使用可能文字を示すメッセージ文字列を返します。
GetErrMsg_UserInfo ( Err ) ERR_KIND ユーザー情報用のエラーメッセージを返します。

●イベントの一覧

名前 引数 戻り値 説明
AcceptedClient ( Object, NSDServerEventArgs ) なし 新しいクライアントが接続された時に発生します。
DisconnectedClient ( Object, NSDServerEventArgs ) なし クライアントが切断した時に発生します。
ReceivedClient_Login ( Object, NSDReceiveLoginEventArgs ) なし ログインした時に発生します。
ReceivedClientData ( Object, NSDReceiveDataEventArgs ) なし クライアントからデータを受信した時に発生します。
ReceivedClientUploadData ( Object, NSDReceiveWriteDataEventArgs ) なし クライアントから受信したアップロードデータを書き込んだ時に発生します。
ReceivedClientUploadEnd ( Object, NSDReceiveWriteDataEventArgs ) なし アップロード終了時に発生します。
SendClientDownloadData ( Object, NSDSendDataEventArgs ) なし クライアントへダウンロードデータを送信した後に発生します。
SendClientDownloadStop ( Object, NSDSendDataEventArgs ) なし クライアントからダウンロード中止を受信した時に発生します。
SendClientDownloadEnd ( Object, NSDSendDataEventArgs ) なし クライアントからダウンロード終了を受信した後に発生します。

●定数の一覧

名前:SERVER_STATE (サーバーの状態)
名前 内容
None 初期状態。
Listening 受信待ち状態。
Stopped 停止状態。

 

名前:NSD_INTERNETWORK (ネットワークの種類)
名前 内容
IPv4 Address for IP version 4.
IPv6 Address for IP version 6.

●NSDServerInfoコンストラクタの説明

構文:Public Sub New()

使用法:Public ClsPub_Server As New NSDSocket.NSDServerInfo

引数:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub
End Class

 

構文:Public Sub New( NSD_INTERNETWORK )

使用法:Public ClsPub_Server As New NSDSocket.NSDServerInfo(NSD_INTERNETWORK.IPv4)

引数:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo(NSD_INTERNETWORK.IPv4)
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub
End Class

●NSDServerInfoプロパティの説明

名前:PortNo

構文:Public Property PortNo() As Integer

機能:ポート番号を設定します。

引数:なし。

値:Integer

値の説明:

ポート番号を設定します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ポートの指定.
        Cls_Server.PortNo = 2345
    End Sub
End Class

 

名前:ServerState

構文:Public ReadOnly Property ServerState() As SERVER_STATE

機能:サーバーの状態を返します。

引数:なし。

値:SERVER_STATE

値の説明:

サーバーの状態を返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Select Case Cls_Server.ServerState
            Case Cls_Server.NSDServerInfo.SERVER_STATE.Listening
            ' 受信待ち状態。
                   :
            Case Else
                   :
        End Select
    End Sub
End Class

 

名前:SocketConnectLoginTimeOut

構文:Public Property SocketConnectLoginTimeOut() As Integer

機能:ログインタイムアウトを設定します。

引数:なし。

値:Integer

値の説明:

ログインタイムアウトを設定します(ミリ秒)。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ログインタイムアウトを10分にします。
        Cls_Server.SocketConnectLoginTimeOut = 600000
    End Sub
End Class

 

名前:DataSocketConnectTimeOut

構文:Public Property DataSocketConnectTimeOut() As Integer

機能:データ用ソケットに接続されるまでの時間を設定します。

引数:なし。

値:Integer

値の説明:

データ用ソケットに接続されるまでの時間を設定します(ミリ秒)。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' データ用ソケットに接続されるまでの時間を2分にします。
        Cls_Server.DataSocketConnectTimeOut = 120000
    End Sub
End Class

 

名前:LoginNameCheckCount

構文:Public Property LoginNameCheckCount() As Integer

機能:ログイン名の確認でリトライができる最大数を設定します。

引数:なし。

値:Integer

値の説明:

ログイン名の確認でリトライができる最大数を設定します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ログイン名の確認でリトライができる最大数を3回にします。
        Cls_Server.LoginNameCheckCount = 3
    End Sub
End Class

 

名前:PasswordCheckCount

構文:Public Property PasswordCheckCount() As Integer

機能:パスワードの確認でリトライができる最大数を設定します。

引数:なし。

値:Integer

値の説明:

パスワードの確認でリトライができる最大数を設定します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' パスワードの確認でリトライができる最大数を3回にします。
        Cls_Server.PasswordCheckCount = 3
    End Sub
End Class

 

名前:UserFileName

構文:Public Property UserFileName() As String

機能:ユーザー定義ファイル名を設定します。

引数:なし。

値:String

値の説明:

ユーザー定義ファイル名を設定します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ユーザー定義ファイル名を指定します。
        Cls_Server.UserFileName = Application.StartupPath & "\SampleDataFolder\UserTbl.xml"
    End Sub
End Class

 

名前:StdFolder

構文:Public Property StdFolder() As String

機能:基準フォルダーを設定します。

引数:なし。

値:String

値の説明:

基準フォルダーを設定します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 基準フォルダーを設定します。
        Cls_Server.StdFolder = Application.StartupPath & "\SampleDataFolder"
    End Sub
End Class

●NSDServerInfoメソッドの説明

名前:Dispose

構文:Public Sub Dispose()

機能:リソースの解放を行います。

※終了時に必ず呼び出します。

引数:なし。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub
End Class

 

名前:Listen

機能:クライアントからの受信待ちを行います。

@クライアントからの受信待ちを行います。

構文:Public Function Listen() As Boolean

引数:なし。

戻り値:Boolean

戻り値の説明:

True:成功 False:失敗。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()
    End Sub
End Class

 

Aクライアントからの受信待ちを行います。

構文:Public Function Listen( PortNo ) As Boolean

引数:

名前 引数渡しの方法 説明
PortNo Integer 値渡し(ByVal) ポート番号を渡します。

戻り値:Boolean

戻り値の説明:

True:成功 False:失敗

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen(2345)
    End Sub
End Class

 

 

名前:ListenEnd

構文:Public Sub ListenEnd()

機能:受信待ちを終了します。

引数:なし。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ポートの指定.
        Select Case Cls_Server.ServerState
            Case Cls_Server.NSDServerInfo.SERVER_STATE.Listening
            ' 受信待ち状態。
                 Cls_Server.ListenEnd()
                     :
            Case Else
                     :
        End Select
    End Sub
End Class

 

名前:CloseClient

構文:Public Sub CloseClient( Receive )

機能:指定クライアントを切断します。

引数:

名前 引数渡しの方法 説明
Receive NSDSocket.NSDReceive 値渡し(ByVal) 受信情報を渡します。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_LoginList As New System.Collections.ArrayList
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        If Not (Cls_LoginList Is Nothing) Then
            Cls_Server.CloseClient(Cls_LoginList.Item(0))
        End If
    End Sub
End Class

 

名前:CloseClientAll

構文:Public Sub CloseClientAll()

機能:全てのクライアントを切断します。

引数:なし。

戻り値:なし。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.CloseClientAll()
    End Sub
End Class

 

名前:IsAddOkUserList

構文:Public Function IsAddOkUserList( UserInfo ) As ERR_KIND

機能:ユーザーリストに追加可能ユーザーかを確認します。

引数:

名前 引数渡しの方法 説明
UserInfo NSDSocket.NSD_SocketUserInfo.NSDUserInfo 値渡し(ByVal) ユーザー情報を渡します。

戻り値:NSDSocket.NSD_SocketUserInfo.ERR_KIND

戻り値の説明:

エラー定数(ERR_KIND)で返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Dim Cls_OneUser As New NSDSocket.NSD_SocketUserInfo.NSDUserInfo
        Cls_OneUser.Name = "ユーザー名"
        Cls_OneUser.LoginName = "ログイン名"
        Cls_Server.IsAddOkUserList(Cls_OneUser)
    End Sub
End Class

 

名前:AddUserList

構文:Public Function AddUserList( UserInfo ) As ERR_KIND

機能:ユーザーリストにユーザーを追加します。

引数:

名前 引数渡しの方法 説明
UserInfo NSDSocket.NSD_SocketUserInfo.NSDUserInfo 参照渡し(ByRef) ユーザー情報を渡します。

戻り値:NSDSocket.NSD_SocketUserInfo.ERR_KIND

戻り値の説明:

エラー定数(ERR_KIND)で返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Dim Cls_OneUser As New NSDSocket.NSD_SocketUserInfo.NSDUserInfo
        Cls_OneUser.Name = "ユーザー名"
        Cls_OneUser.LoginName = "ログイン名"
        Cls_Server.AddUserList(Cls_OneUser)
    End Sub
End Class

 

名前:ChangeUserList

構文:Public Function ChangeUserList( UserInfo ) As ERR_KIND

機能:ユーザーリストのユーザーを変更します。

引数:

名前 引数渡しの方法 説明
UserInfo NSDSocket.NSD_SocketUserInfo.NSDUserInfo 値渡し(ByVal) ユーザー情報を渡します。

戻り値:NSDSocket.NSD_SocketUserInfo.ERR_KIND

戻り値の説明:

エラー定数(ERR_KIND)で返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.ReadUserList("ファイル名")
        Dim Cls_UList As ArrayList = Cls_Server.GetUserList()
               :
        Dim Cls_OneUser As NSDSocket.NSD_SocketUserInfo.NSDUserInfo = Cls_UList.Item(0)
        Cls_OneUser.Name = "変更ユーザー名"
               :
        Cls_Server.ChangeUserList(Cls_OneUser)
    End Sub
End Class

 

名前:DeleteUserList

構文:Public Function DeleteUserList( UserInfo ) As ERR_KIND

機能:ユーザーリストからユーザーを削除します。

引数:

名前 引数渡しの方法 説明
UserInfo NSDSocket.NSD_SocketUserInfo.NSDUserInfo 値渡し(ByVal) ユーザー情報を渡します。

戻り値:NSDSocket.NSD_SocketUserInfo.ERR_KIND

戻り値の説明:

エラー定数(ERR_KIND)で返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.ReadUserList("ファイル名")
        Dim Cls_UList As ArrayList = Cls_Server.GetUserList()
        Cls_Server.DeleteUserList(Cls_UList.Item(0))
    End Sub
End Class

 

名前:GetUserList

構文:Public Function GetUserList() As ArrayList

機能:ユーザーリストを返します。

引数:なし。

戻り値:ArrayList

戻り値の説明:

NSDSocket.NSD_SocketUserInfo.NSDUserInfoのリストを返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.ReadUserList("ファイル名")
        Dim Cls_UList As ArrayList = Cls_Server.GetUserList()
    End Sub
End Class

 

名前:GetUserCount

構文:Public Function GetUserCount() As Integer

機能:ユーザーの件数を返します。

引数:なし。

戻り値:Integer

戻り値の説明:

ユーザーの件数を返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.ReadUserList("ファイル名")
        MsgBox("登録ユーザー数:" & Cls_Server.GetUserCount().ToString())
    End Sub
End Class

 

名前:GetUserToUserList

構文:Public Function GetUserToUserList( ID , UserInfo ) As ERR_KIND

機能:ユーザーリストから指定ユーザー情報を取得します。

引数:

名前 引数渡しの方法 説明
ID Integer 値渡し(ByVal) ユーザーIDを渡します。
UserInfo NSDSocket.NSD_SocketUserInfo.NSDUserInfo 参照渡し(ByRef) ユーザー情報を返します。

戻り値:NSDSocket.NSD_SocketUserInfo.ERR_KIND

戻り値の説明:

エラー定数(ERR_KIND)で返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.ReadUserList("ファイル名")
        Dim Cls_OneUser As NSDSocket.NSD_SocketUserInfo.NSDUserInfo = Nothing
        Cls_Server.GetUserToUserList( 1 , Cls_OneUser )
    End Sub
End Class

 

名前:ReadUserList

構文:Public Function ReadUserList( FileName ) As Boolean

機能:ユーザーリストをファイルから読み込みます。

引数:

名前 引数渡しの方法 説明
FileName String 値渡し(ByVal) ファイルのフルパス名を渡します。

戻り値:Boolean

戻り値の説明:

True:成功 False:失敗

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.ReadUserList("ファイル名")
    End Sub
End Class

 

名前:WriteUserList

構文:Public Function WriteUserList( FileName ) As Boolean

機能:ユーザーリストをファイルに書き込みます。

引数:

名前 引数渡しの方法 説明
FileName String 値渡し(ByVal) ファイルのフルパス名を渡します。

戻り値:Boolean

戻り値の説明:

True:成功 False:失敗

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        Cls_Server.WriteUserList("ファイル名")
    End Sub
End Class

 

名前:IsOkLoginNameString

構文:Public Function IsOkLoginNameString( Name ) As ERR_KIND

機能:ログイン名の確認を行います。

引数:

名前 引数渡しの方法 説明
Name String 値渡し(ByVal) ログイン名を渡します。

戻り値:NSDSocket.NSD_SocketUserInfo.ERR_KIND

戻り値の説明:

エラー定数(ERR_KIND)で返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ログイン名の確認。
        Dim Int_Err As NSDSocket.NSD_SocketUserInfo.ERR_KIND
        Int_Err = ClsPub_Server.IsOkLoginNameString("ログイン名")
    End Sub
End Class

 

名前:GetLoginOkStringMsg

構文:Public Function GetLoginOkStringMsg() As String

機能:ログインで使用可能文字を示すメッセージ文字列を返します。

引数:なし。

戻り値:String

戻り値の説明:

ログインで使用可能文字を示すメッセージ文字列を返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ログイン名の確認。
        Dim Int_Err As NSDSocket.NSD_SocketUserInfo.ERR_KIND
        Int_Err = ClsPub_Server.IsOkLoginNameString("ログイン名")
        Select Case Int_Err
                    :
            Case NSDSocket.NSD_SocketUserInfo.ERR_KIND.LoginNameNotUseString
            ' ログイン名に使用できない文字が含まれています。
                 Dim Str_OkString As String = ClsPub_Server.GetLoginOkStringMsg()
                    :
        End Select
    End Sub
End Class

 

名前:GetErrMsg_UserInfo

構文:Public Function GetErrMsg_UserInfo( Err ) As String

機能:ユーザー情報用のエラーメッセージを返します。

引数:

名前 引数渡しの方法 説明
Err NSDSocket.NSD_SocketUserInfo.ERR_KIND 値渡し(ByVal) エラー番号を渡します。

戻り値:String

戻り値の説明:

エラーメッセージを返します。
※エラーが無い場合はNothingを返します。

使用例:

Public Class Form1
    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' ログイン名の確認。
        Dim Int_Err As NSDSocket.NSD_SocketUserInfo.ERR_KIND
        Int_Err = ClsPub_Server.IsOkLoginNameString("ログイン名")
        If Int_Err <> NSDSocket.NSD_SocketUserInfo.ERR_KIND.OK Then
            MsgBox(ClsPub_Server.GetErrMsg_UserInfo(Int_Err))
        End If
    End Sub
End Class

●NSDServerInfoイベントの説明

 

名前:AcceptedClient

構文:Public Event AcceptedClient( sender , e )

機能:新しいクライアントが接続された時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDServerEventArgs 値渡し(ByVal) サーバーイベントデータ用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

        ' クライアントが接続した場合に発生します。
        AddHandler NSDServer.AcceptedClient, AddressOf MyClass.AcceptedClient
        ' ログインした場合に発生します。
        AddHandler NSDServer.ReceivedClient_Login, AddressOf MyClass.ReceivedClient_Login
        ' クライアントが切断した時に発生します。
        AddHandler NSDServer.DisconnectedClient, AddressOf MyClass.DisconnectedClient
        ' クライアントからデータを受信した時に発生します。
        AddHandler NSDServer.ReceivedClientData, AddressOf MyClass.ReceiveData

        ' クライアントから受信したアップロードデータを書き込んだ時に発生します。
        AddHandler NSDServer.ReceivedClientUploadData, AddressOf MyClass.ReceivedUploadData
        ' アップロード終了時に発生します。
        AddHandler NSDServer.ReceivedClientUploadEnd, AddressOf MyClass.ReceivedUploadEnd

        ' クライアントへダウンロードデータを送信した後に発生します。
        AddHandler NSDServer.SendClientDownloadData, AddressOf MyClass.SendDownloadData
        ' クライアントがダウンロード中止した時に発生します。
        AddHandler NSDServer.SendClientDownloadStop, AddressOf MyClass.SendDownloadStop
        ' クライアントからダウンロード終了を受信した時に発生します。
        AddHandler NSDServer.SendClientDownloadEnd, AddressOf MyClass.SendDownloadEnd
    End Sub

    Private Sub AcceptedClient(ByVal sender As Object, ByVal e As NSDSocket.NSDServerEventArgs)
           :
        クライアントが接続した時の処理を行います。
           :
    End Sub

    Private Sub ReceivedClient_Login(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveLoginEventArgs)
           :
        ログインした時の処理を行います。
           :
    End Sub

    Private Sub DisconnectedClient(ByVal sender As Object, ByVal e As NSDSocket.NSDServerEventArgs)
           :
        クライアントが切断した時の処理を行います。
           :
    End Sub

    Private Sub ReceiveData(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveDataEventArgs)
           :
        クライアントからデータを受信した時の処理を行います。
           :
    End Sub

    Private Sub ReceivedUploadData(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveWriteDataEventArgs)
           :
        クライアントから受信したアップロードデータを書き込んだ時の処理を行います。
           :
    End Sub

    Private Sub ReceivedUploadEnd(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveWriteDataEventArgs)
           :
        アップロード終了時の処理を行います。
           :
    End Sub

    Private Sub SendDownloadData(ByVal sender As Object, ByVal e As NSDSocket.NSDSendDataEventArgs)
           :
       クライアントへダウンロードデータを送信した後の処理を行います。
           :
    End Sub

    Private Sub SendDownloadStop(ByVal sender As Object, ByVal e As NSDSocket.NSDSendDataEventArgs)
           :
       クライアントがダウンロード中止した時の処理を行います。
           :
    End Sub

    Private Sub SendDownloadEnd(ByVal sender As Object, ByVal e As NSDSocket.NSDSendDataEventArgs)
           :
       クライアントからダウンロード終了を受信した時の処理を行います。
           :
    End Sub

           :

End Class

 

名前:DisconnectedClient

構文:Public Event DisconnectedClient( sender , e )

機能:クライアントが切断した時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDServerEventArgs 値渡し(ByVal) サーバーイベントデータ用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

            :
        ' クライアントが切断した時に発生します。
        AddHandler NSDServer.DisconnectedClient, AddressOf MyClass.DisconnectedClient
            :
    End Sub

           :

    Private Sub DisconnectedClient(ByVal sender As Object, ByVal e As NSDSocket.NSDServerEventArgs)
           :
        クライアントが切断した時の処理を行います。
           :
    End Sub

           :

End Class

 

名前:ReceivedClient_Login

構文:Public Event ReceivedClient_Login( sender , e )

機能:クライアントが切断した時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDReceiveLoginEventArgs 値渡し(ByVal) 受信イベントログイン用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing

    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' ログインした場合に発生します。
        AddHandler NSDServer.ReceivedClient_Login, AddressOf MyClass.ReceivedClient_Login
             :
    End Sub

           :

    Private Sub ReceivedClient_Login(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveLoginEventArgs)
           :
        ログインした時の処理を行います。
           :
    End Sub

           :

End Class

 

名前:ReceivedClientData

構文:Public Event ReceivedClientData( sender , e )

機能:クライアントからデータを受信した時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDReceiveDataEventArgs 値渡し(ByVal) 受信イベントデータ用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing

    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' クライアントからデータを受信した時に発生します。
        AddHandler NSDServer.ReceivedClientData, AddressOf MyClass.ReceiveData
             :
    End Sub

           :

    Private Sub ReceiveData(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveDataEventArgs)
           :
        クライアントからデータを受信した時の処理を行います。
           :
    End Sub

           :

End Class

 

名前:ReceivedClientUploadData

構文:Public Event ReceivedClientUploadData( sender , e )

機能:クライアントから受信したアップロードデータを書き込んだ時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDReceiveWriteDataEventArgs 値渡し(ByVal) 受信データの書き込み済みイベント用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' クライアントから受信したアップロードデータを書き込んだ時に発生します。
        AddHandler NSDServer.ReceivedClientUploadData, AddressOf MyClass.ReceivedUploadData
             :
    End Sub

           :

    Private Sub ReceivedUploadData(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveWriteDataEventArgs)
           :
        クライアントから受信したアップロードデータを書き込んだ時の処理を行います。
           :
    End Sub

           :
End Class

 

名前:ReceivedClientUploadEnd

構文:Public Event ReceivedClientUploadEnd( sender , e )

機能:アップロード終了時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDReceiveWriteDataEventArgs 値渡し(ByVal) 受信データの書き込み済みイベント用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' アップロード終了時に発生します。
        AddHandler NSDServer.ReceivedClientUploadEnd, AddressOf MyClass.ReceivedUploadEnd
             :
    End Sub

           :

    Private Sub ReceivedUploadEnd(ByVal sender As Object, ByVal e As NSDSocket.NSDReceiveWriteDataEventArgs)
           :
        アップロード終了時の処理を行います。
           :
    End Sub

           :
End Class

 

名前:SendClientDownloadData

構文:Public Event SendClientDownloadData( sender , e )

機能:クライアントへダウンロードデータを送信した後に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDSendDataEventArgs 値渡し(ByVal) 送信データを送信後に発生するイベント用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' クライアントへダウンロードデータを送信した後に発生します。
        AddHandler NSDServer.SendClientDownloadData, AddressOf MyClass.SendDownloadData
             :
    End Sub

           :

    Private Sub SendDownloadData(ByVal sender As Object, ByVal e As NSDSocket.NSDSendDataEventArgs)
           :
       クライアントへダウンロードデータを送信した後の処理を行います。
           :
    End Sub

           :
End Class

 

名前:SendClientDownloadStop

構文:Public Event SendClientDownloadStop( sender , e )

機能:クライアントからダウンロード中止を受信した時に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDSendDataEventArgs 値渡し(ByVal) 送信データを送信後に発生するイベント用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' クライアントがダウンロード中止した時に発生します。
        AddHandler NSDServer.SendClientDownloadStop, AddressOf MyClass.SendDownloadStop
               :
    End Sub

           :

    Private Sub SendDownloadStop(ByVal sender As Object, ByVal e As NSDSocket.NSDSendDataEventArgs)
           :
       クライアントがダウンロード中止した時の処理を行います。
           :
    End Sub

           :
End Class

 

名前:SendClientDownloadEnd

構文:Public Event SendClientDownloadEnd( sender , e )

機能:クライアントからダウンロード終了を受信した後に発生するイベント。

引数:

名前 引数渡しの方法 説明
sender Object 値渡し(ByVal) 呼び出し元のオブジェクト。
e NSDSendDataEventArgs 値渡し(ByVal) 送信データを送信後に発生するイベント用クラスを受け取ります。

戻り値:なし。

使用例:

Public Class Form1
    Dim Cls_Server As NSDSocket.NSDServerInfo = Nothing
    ' Formのロード処理。
    Private Sub Form1_Load( ByVal sender As System.Object,  ByVal e As System.EventArgs) _
                            Handles MyBase.Load
        ' リソースを割り当てます。
        Cls_Server = New NSDSocket.NSDServerInfo()
    End Sub

    ' Formのクローズ処理。
    Private Sub Form1_FormClosing(ByVal sender As Object, _
                                  ByVal e As System.Windows.Forms.FormClosingEventArgs) _
                                  Handles Me.FormClosing
        ' 解放します。
        Cls_Server.Dispose()
        Cls_Server = Nothing
    End Sub

    Private Sub Button1_Click( ByVal sender As System.Object, _
                               ByVal e As System.EventArgs) Handles Button1.Click
        ' 受信待ちを開始します。
        Cls_Server.Listen()

             :
        ' クライアントからダウンロード終了を受信した時に発生します。
        AddHandler NSDServer.SendClientDownloadEnd, AddressOf MyClass.SendDownloadEnd
             :
    End Sub

           :

    Private Sub SendDownloadEnd(ByVal sender As Object, ByVal e As NSDSocket.NSDSendDataEventArgs)
           :
       クライアントからダウンロード終了を受信した時の処理を行います。
           :
    End Sub

           :
End Class

Copyright (C) 2016 Nihon System Developer Corp. All Rights Reserved.