Classe: tSktSslConn
Faz o tratamento de envio e recepção de dados da conexão SSL com o cliente.
Hierarquia |
|
| A classe não possui hierarquia. |
|
|
Construtores |
|
| NewCria um objeto da Classe de Conexão de Socket SSL (Conexão SSL). Porém a criação deste objeto é feita pela função “Accept” da classe “tSktSslSrv”
| Sintaxe |
|
| tSktSslConn():New() --> oRet |
| Parâmetros |
|
|
| Retorno |
|
| Nome | Tipo | Descrição | oRet | Objeto | Cria um objeto da Classe de Conexão de Socket SSL (Conexão SSL) |
| Observações |
| |
| Exemplo |
| | oObjConn := tSktSslConn():New() |
|
|
|
|
Métodos |
|
| SendEnvia um buffer de dados.
| Sintaxe |
|
| TSktSslConn:Send( < cBuffer >, < nLen > ) --> nRet |
| Parâmetros |
|
| Nome | Tipo | Descrição | Obrigatório | Referência | cBuffer | Caracter | Buffer a ser enviado | X |
| nLen | Numérico | Número de bytes a serem enviados | X |
|
| Retorno |
| | Nome | Tipo | Descrição | nRet | Numérico | Número de bytes enviados |
| Observações |
| | Se o número de bytes enviados (nRet) for diferente do número de bytes solicitados (nLen), houve erro no envio. | Exemplo |
| | nRet := oObjConn:Send(cOutBuffer, 1000) |
|
|
|
|
| ReceiveRecebe um buffer com os dados.
| Sintaxe |
|
| TSktSslConn:Receive ( < cBuffer >, < nLen >, < nTimeOut > ) --> nRet |
| Parâmetros |
|
| Nome | Tipo | Descrição | Obrigatório | Referência | cBuffer | Caracter | Buffer com os dados recebidos | X | X | nLen | Numérico | Número máximo de bytes a serem recebidos no buffer | X |
| nTimeOut | Numérico | Timeout de recepção de dados |
|
|
| Retorno |
| | Nome | Tipo | Descrição | nRet | Numérico | Número de bytes recebidos |
| Observações |
| | Se nTimeOut for 0 (zero) fica aguardando indefinidamente até receber algum dado. Se o número de bytes recebidos (nRet) for menor que zero, houve erro de recepção, e se nRet for zero, não há mais dados para receber. | Exemplo |
| | Local nMAX_BUFFER:= 10240 ... cBuffer := space(nMAX_BUFFER) nRet := oObjConn:Receive(cBuffer, nMAX_BUFFER, 10) |
|
|
|
|
| GetErrorObtém o erro gerado na Conexão.
| Sintaxe |
|
| TSktSslConn:GetError ( < cMsgErr > ) --> nRet |
| Parâmetros |
|
| Nome | Tipo | Descrição | Obrigatório | Referência | cMsgErr | Caracter | Contém a mensagem de erro | X | X |
| Retorno |
| | Nome | Tipo | Descrição | nRet | Lógico | Contém o código do erro |
| Observações |
| | Se não houver erro será retornado 0 (zero). | Exemplo |
| | nErrCode := oObjConn:GetError(@cErrMsg) |
|
|
|
|
| CloseFecha a Conexão SSL.
| Sintaxe |
|
| TSktSslConn:Close() --> lRet |
| Parâmetros |
|
|
| Retorno |
| | Nome | Tipo | Descrição | lRet | Lógico | Verdadeiro (.T.) se fechou corretamente ou falso (.F.) se houve algum erro no fechamento |
| Observações |
| |
| Exemplo |
| | |
|
|
|
| DataWaitingVerifica a quantidade de bytes disponíveis para leitura.
| Sintaxe |
|
| TSktSslConn:DataWaiting() --> nRet |
| Parâmetros |
|
|
| Retorno |
| | Nome | Tipo | Descrição | nRet | Numérico | Quantidade de bytes disponíveis para leitura |
| Observações |
| |
| Exemplo |
| | nRet := oObjConn:DataWaiting() |
|
|
|
|
| GetIPStrRetorna o IP do cliente conectado.
| Sintaxe |
|
| TSktSslConn:GetIPStr() --> cRet |
| Parâmetros |
|
|
| Retorno |
| | Nome | Tipo | Descrição | cRet | Caracter | IP do cliente conectado a esta conexão |
| Observações |
| |
| Exemplo |
| | cRet := oObjConn:GetIPStr() |
|
|
|
|
| SetVerboseIndica se deve ou não gerar mensagens de Debug.
| Sintaxe |
|
| TSktSslConn:SetVerbose( < lVerbose >) --> lRet |
| Parâmetros |
|
| Nome | Tipo | Descrição | Obrigatório | Referência | lVerbose | Lógico | Verdadeiro (.T.) para modo verboso ou falso (.F.) para modo não verboso | X |
|
| Retorno |
| | Nome | Tipo | Descrição | lRet | Lógico | Verdadeiro (.T.) se alterou para o modo solicitado corretamente ou falso (.F.) se houve algum erro |
| Observações |
| |
| Exemplo |
| | lRet := oObjConn:SetVerbose(.T.) |
|
|
|
|
| IsConnectedVerifica se a conexão está conectada e válida.
| Sintaxe |
|
| TSktSslConn:IsConnected() --> lRet |
| Parâmetros |
|
|
| Retorno |
| | Nome | Tipo | Descrição | lRet | Lógico | Verdadeiro (.T.) se está conectada e falso (.F.) se não está conectada |
| Observações |
| |
| Exemplo |
| | lRet := oObjConn:IsConnected() |
|
|
|
|
| GetStatisticsAtualiza todas as propriedades de estatísticas de envio e recepção da conexão.
| Sintaxe |
|
| TSktSslConn:GetStatistics() --> lRet |
| Parâmetros |
|
|
| Retorno |
| | Nome | Tipo | Descrição | lRet | Lógico | Verdadeiro (.T.) se atualizou corretamente, e falso (.F.) se houve algum erro |
| Observações |
| | Se esta função não for chamada, as propriedades de envio e recepção da conexão não são atualizadas. | Exemplo |
| | lRet := oObjConn:GetStatistics() |
|
|
|
|
Propriedades | |
| nIOSentIndica o número de envios da conexão.
| Sintaxe |
|
| | Retorno |
| | Nome | Tipo | Descrição | nIOSent | Numérico | número de envios |
| Observações |
| | Ver a função GetStatistics. | Exemplo |
| | |
|
| |
| nIORecvIndica o número de recepções da conexão.
| Sintaxe |
|
| | Retorno |
| | Nome | Tipo | Descrição | nIORecv | Numérico | número de recepções |
| Observações |
| | Ver a função GetStatistics. | Exemplo |
| | |
|
| |
| nBytesSentIndica o número de bytes enviados na conexão.
| Sintaxe |
|
| | Retorno |
| | Nome | Tipo | Descrição | nBytesSent | Numérico | número de bytes enviados |
| Observações |
| | Ver a função GetStatistics. | Exemplo |
| | |
|
| |
| nBytesRecvIndica o número de bytes recebidos na conexão.
| Sintaxe |
|
| | Retorno |
| | Nome | Tipo | Descrição | nBytesRecv | Numérico | número de bytes recebidos |
| Observações |
| | Ver a função GetStatistics. | Exemplo |
| | |
|
| |
| nMaxBytesSentIndica o total de bytes enviados em uma mensagem.
| Sintaxe |
|
| TSktSslConn:nMaxBytesSent |
| Retorno |
| | Nome | Tipo | Descrição | nMaxBytesSent | Numérico | total de bytes enviados em uma mensagem |
| Observações |
| | Ver a função GetStatistics. | Exemplo |
| | MaxBytesSent:= oObjConn:nMaxBytesSent |
|
|
| |
| nMaxBytesRecvIndica total de bytes recebidos em uma mensagem.
| Sintaxe |
|
| TSktSslConn:nMaxBytesRecv |
| Retorno |
| | Nome | Tipo | Descrição | nMaxBytesRecv | Numérico | total de bytes recebidos em uma mensagem |
| Observações |
| | Ver a função GetStatistics. | Exemplo |
| | MaxBytesRecv := oObjConn:nMaxBytesRecv |
|
|
| |
Abrangência
Protheus 11 com release superior a 7.00.121227P
Veja Também
tSktSslSrv , SetSslObj , GetSslObj