A vers\u00e3o do DataSnap que acompanha o Delphi XE2 finalmente trouxe o t\u00e3o esperado e solicitado recurso para controlar e monitorar conex\u00f5es efetuadas atrav\u00e9s de TCP\/IP em um servidor DataSnap, at\u00e9 a vers\u00e3o XE o monitoramento e controle era poss\u00edvel, entretanto requeria muito c\u00f3digo por parte do desenvolvedor. No Delphi XE2 o framework do DataSnap traz classes e m\u00e9todos que facilitam e muito isso e neste artigo vou explicar como funciona.<\/p>\n
Pra come\u00e7ar, toda a implementa\u00e7\u00e3o do monitoramento e controle est\u00e1 implementada para protocolo TCP\/IP o que permite monitorar e derrubar qualquer conex\u00e3o, assim sendo o componente TDSTCPServerTransporter recebeu dois novos eventos OnConnect e OnDisconnect, estes eventos s\u00e3o muito importantes, pois atrav\u00e9s deles gerenciamos a lista de conex\u00f5es no servidor podendo fazer o que quiser com as mesmas. Al\u00e9m disso toda conex\u00e3o est\u00e1 associado a um Session ID que \u00e9 \u00fanico, o Session ID j\u00e1 est\u00e1 dispon\u00edvel desde as vers\u00f5es anteriores do DataSnap.<\/p>\n
Para exemplificar o funcionamento e implementa\u00e7\u00e3o do monitoramento definimos uma lista (collection) conforme abaixo para armazenar as inst\u00e2ncias de cada conex\u00e3o (TIdTCPConnection) e protocolo (TDSTCPChannel)<\/p>\n
FConnections: TObjectDictionary<TIdTCPConnection,TDSTCPChannel>;<\/pre>\n<\/p>\n
A partir dai implementamos os eventos OnConnect e OnDisconnect no TDSTCPServerTransporter. Implementar o evento OnConnect \u00e9 bem simples, voc\u00ea tem apenas que armazenar as informa\u00e7\u00f5es referente a conex\u00e3o na sua lista e caso tenha alguma interface para atualizar com as informa\u00e7\u00f5es referentes a esta conex\u00e3o, assim faze-lo.<\/p>\n
O c\u00f3digo abaixo adiciona a nova conex\u00e3o utilizando os m\u00e9todos TMonitor.Enter e TMonitor.Exit para assegurar que nenhuma outra thread ir\u00e1 tentar atualizar esta lista.<\/p>\n
Ap\u00f3s adicionar a lista utilizamos o m\u00e9todo EnableKeepAlive que irei explicar em seguida.<\/p>\n
procedure TCMServerForm.CMServerTransportConnectEvent(Event: TDSTCPConnectEventObject);\r\nbegin\r\n System.TMonitor.Enter(FConnections);\r\n try\r\n FConnections.Add(TIdTCPConnection(Event.Connection), Event.Channel);\r\n finally\r\n System.TMonitor.Exit(FConnections);\r\n end;\r\n\r\n \/\/Enable Keep-alive for this new connection.\r\n Event.Channel.EnableKeepAlive(10000);\r\nend;<\/pre>\nA implementa\u00e7\u00e3o do m\u00e9todo OnDisconnect ter\u00e1 que localizar a inst\u00e2ncia da conex\u00e3o e remove-la da lista, OnDisconnect ser\u00e1 executado quando a aplica\u00e7\u00e3o cliente desconectar do servidor, seja de forma natural, queda de rede, etc.<\/p>\n
Por padr\u00e3o, o evento\u00a0OnDisconnect\u00a0n\u00e3o ser\u00e1 notificado\u00a0se o cliente\u00a0de forma abrupta\u00a0perde sua conex\u00e3o\u00a0internet.\u00a0Isso acontece porque a conex\u00e3o Socket permanece aberta at\u00e9 que ocorra alguma chamada e esta falhe.\u00a0Se o sistema operacional est\u00e1 configurado para usar\u00a0pacotes keep-alive\u00a0para todas as conex\u00f5es\u00a0TCP\/IP e com base na sua\u00a0configura\u00e7\u00e3o, voc\u00ea\u00a0ver\u00e1 o\u00a0evento OnDisconnect ser notificado.\u00a0Se voc\u00ea\u00a0desejar controlar este comportamento\u00a0para cada conex\u00e3o, ent\u00e3o use os m\u00e9todos EnableKeepAlive e DisableKeepAlive para cada inst\u00e2ncia do TDSTCPChannel.<\/p>\n
No c\u00f3digo acima foi definido para cada conex\u00e3o o KeepAlive em 10 segundos, isso quer dizer que o server ir\u00e1 enviar um pacote (fazer um ping) no cliente quando o mesmo estiver inativo por mais de 10 segundos, se o cliente n\u00e3o responder o server ir\u00e1 tentar novamente, a quantidade de tentativas \u00e9 baseada no sistema operacional, por exemplo Windows 7 tenta 10 vezes. Voc\u00ea ainda pode definir o intervalo entre os pings, basta configurar o KeepAliveInterval.<\/p>\n
O c\u00f3digo abaixo demonstra como remover a inst\u00e2ncia da conex\u00e3o da lista e como atualizar a interface do usu\u00e1rio utilizando TThread.Synchronize.<\/p>\n
procedure TCMServerForm.CMServerTransportDisconnectEvent(Event: TDSTCPDisconnectEventObject);\r\nvar\r\n Index: Integer;\r\nbegin\r\n if (FConnections = nil) or (Event.Connection = nil) then\r\n Exit;\r\n\r\n \/\/This is called when a TCP connection is closed, for whatever reason.\r\n System.TMonitor.Enter(FConnections);\r\n try\r\n FConnections.Remove(TIdTCPConnection(Event.Connection));\r\n\r\n TThread.Synchronize(nil, procedure\r\n begin\r\n \/\/update the connection list box, removing the connection that was just closed\r\n Index := ConnectionsList.Items.IndexOfObject(Event.Connection);\r\n if Index > -1 then\r\n begin\r\n ConnectionsList.Items.Delete(Index);\r\n\r\n if ConnectionsList.SelCount = 0 then\r\n SessionIdList.ClearSelection;\r\n end;\r\n end);\r\n finally\r\n System.TMonitor.Exit(FConnections);\r\n end;<\/pre>\nAt\u00e9 aqui sabemos quem est\u00e1 conectado ao servidor, a partir dai podemos derrubar qualquer conex\u00e3o, visto que temos a inst\u00e2ncia de cada TDSTCPChannel e este cont\u00e9m o m\u00e9todo close que encerra a conex\u00e3o cliente, ao ser desconectado o lado cliente recebe uma exception quando tentar executar qualquer opera\u00e7\u00e3o no servidor.
\nNo exemplo abaixo encerramos a conex\u00e3o selecionada em um ListBox, o m\u00e9todo GetSelectedChannel busca a inst\u00e2ncia do Channel baseado na conex\u00e3o selecionada no ListBox.<\/p>\nQuando executamos o m\u00e9todo Channel.Close o evento OnDisconnect ser\u00e1 notificado.<\/p>\n
procedure TCMServerForm.ButtCloseSelectedClick(Sender: TObject);\r\nvar\r\n Channel: TDSTCPChannel;\r\nbegin\r\n \/\/Find the selected connection's channel, and then close it.\r\n Channel := GetSelectedChannel;\r\n\r\n \/\/after calling close, the CMServerTransportDisconnectEvent event will be notified.\r\n if Channel <> nil then\r\n begin\r\n Channel.Close;\r\n end;\r\nend;\r\nfunction TCMServerForm.GetSelectedChannel(Conn: TIdTCPConnection): TDSTCPChannel;\r\nbegin\r\n Result := nil;\r\n\r\n \/\/Finds the selected connection\r\n if Conn = nil then\r\n Conn := GetSelectedConnection;\r\n\r\n \/\/uses the selected connection to look up the associated channel.\r\n if Conn <> nil then\r\n FConnections.TryGetValue(Conn, Result)\r\nend;<\/pre>\n