←Select platform

Disconnect Method

Summary

Terminates an active connection.

Syntax

C++

public void Disconnect(  
   string address, 
   bool blacklist 
)

Public Sub Disconnect( _ 
   ByVal address As String, _ 
   ByVal blacklist As Boolean _ 
)

public: 
void Disconnect(  
   String^ address, 
   bool blacklist 
)

Parameters

address
String containing the IP address of the client to disconnect.

blacklist
Boolean value that indicates whether the client should be black-listed from future connections; true to Black-list the client. false to not black-list the client.

Remarks

If the method fails, an error is raised. For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.MediaStreaming; 
 
 
public Server _server = null; 
public bool _result = false; 
 
public void BlacklistClientExample() 
{ 
   try 
   { 
      int Count = 0; 
      string strClients = ""; 
 
      // create an instance of the server object 
      _server = new Leadtools.MediaStreaming.Server(); 
 
 
      // edit network properties, application properties, MIME types, or IP filters here 
 
      // start the server 
      _server.Start(); 
 
      // make sure that there is some clients connected to the server. 
      // this demo will disconnect the first client in the clients list, 
      // and mark it as black list connection. 
 
      // retrieve a copy of the Application Properties 
      Clients clients = _server.GetClients(); 
 
      //Get the Application Properties count 
      Count = clients.Count; 
 
      if (Count > 0) 
      { 
         Client cl = clients[0]; 
 
         // disconnect and black-list the client 
         _server.Disconnect(cl.IPAddress, true); 
 
         // make sure it has now zero active connections. 
         if (cl.Connections == 0) 
         { 
            _result = true; 
            return; 
         } 
      } 
 
      _result = false; 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Imports Leadtools 
Imports Leadtools.MediaStreaming 
 
 
Public _server As Server = Nothing 
Public _result As Boolean = False 
 
Public Sub BlacklistClientExample() 
   Try 
      Dim Count As Integer = 0 
      Dim strClients As String = "" 
 
      ' create an instance of the server object 
      _server = New Leadtools.MediaStreaming.Server() 
 
 
      ' edit network properties, application properties, MIME types, or IP filters here 
 
      ' start the server 
      _server.Start() 
 
      ' make sure that there is some clients connected to the server. 
      ' this demo will disconnect the first client in the clients list, 
      ' and mark it as black list connection. 
 
      ' retrieve a copy of the Application Properties 
      Dim clients As Clients = _server.GetClients() 
 
      'Get the Application Properties count 
      Count = clients.Count 
 
      If Count > 0 Then 
         Dim cl As Client = clients(0) 
 
         ' disconnect and black-list the client 
         _server.Disconnect(cl.IPAddress, True) 
 
         ' make sure it has now zero active connections. 
         If cl.Connections = 0 Then 
            _result = True 
            Return 
         End If 
      End If 
 
      _result = False 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub

Requirements

Target Platforms

Reference

Server Class

Server Members

Help Version 19.0.2017.10.27

Leadtools.MediaStreaming Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaStreaming Namespace

Assemblies