Classe: tSktSslConnFaz o tratamento de envio e recepção de dados da conexão SSL com o cliente.
|
| | A classe não possui hierarquia. |
| |
|
| 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” |
|
| | tSktSslConn():New() --> oRet |
| Parâmetros |
|
| | | | |
|
| Nome | Tipo | Descrição | oRet | Objeto | Cria um objeto da Classe de Conexão de Socket SSL (Conexão SSL) |
| Observações |
|
| |
| | oObjConn := tSktSslConn():New() |
|
|
| | | |
|
| SendEnvia um buffer de dados. |
|
| | ():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 |
|
|
|
| | 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. |
|
| | ():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 |
|
|
| | |
| | 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. |
|
| ():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) |
|
|
| | | | () | | |
| | Nome | Tipo | Descrição | lRet | Lógico | Verdadeiro (.T.) se fechou corretamente ou falso (.F.) se houve algum erro no fechamento |
| Observações |
|
| | | DataWaitingVerifica a quantidade de bytes disponíveis para leitura. |
|
| | () | | | |
| | Nome | Tipo | Descrição | nRet | Numérico | Quantidade de bytes disponíveis para leitura |
| Observações |
|
| | nRet := oObjConn:DataWaiting() |
|
|
|
| |
| | Fecha a Conexão SSL. Retorna o IP do cliente conectado.
| Sintaxe |
|
| | () | | |
| | Nome | Tipo | Descrição | cRet | Caracter | IP do cliente conectado a esta conexão |
| Observações |
| |
|
| | |
| | cRet := oObjConn:GetIPStr() |
|
|
| |
|
| | SetVerboseIndica se deve ou não gerar mensagens de Debug. |
|
| ():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 |
|
|
| |
| | 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 |
| |
|
| | | lRet := oObjConn:SetVerbose(.T.) |
|
|
| |
|
| | IsConnectedVerifica se a conexão está conectada e válida. |
|
| () | | | Nome | Tipo | Descrição | lRet | Lógico | Verdadeiro (.T.) se está conectada e falso (.F.) se não está conectada |
| Observações |
|
| | lRet := oObjConn:IsConnected() |
|
|
| |
|
| | GetStatisticsAtualiza todas as propriedades de estatísticas de envio e recepção da conexão. |
|
| ():GetStatistics() --> lRet |
| Parâmetros |
|
| | | 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() |
|
|
| | | |
| nIOSentIndica o número de envios da conexão. |
|
| | () | 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. |
|
| | () |
| | 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. |
|
| | () |
| | 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. |
|
| () |
| | Nome | Tipo | Descrição | nBytesRecv | Numérico | número de bytes recebidos |
| Observações |
|
|
| | Ver a função GetStatistics. | Exemplo |
| |
|
| | MaxBytesSentIndica o total de bytes enviados em uma mensagem. |
|
| | ()MaxBytesSent MaxBytesSentnMaxBytesSent | Numérico | total de bytes enviados em uma mensagem |
| Observações |
|
|
| | Ver a função GetStatistics. | Exemplo |
|
MaxBytesSent | MaxBytesRecvIndica total de bytes recebidos em uma mensagem. |
|
| | ()MaxBytesRecv MaxBytesRecvnMaxBytesRecv | Numérico | total de bytes recebidos em uma mensagem |
| Observações |
| |
|
| Ver a função GetStatistics. | Exemplo |
| |
|
| MaxBytesRecv := oObjConn: |
|
|
MaxBytesRecv |
Abrangência Protheus 11 com release superior a 7.00.121227P
Veja Também tSktSslSrv , SetSslObj , GetSslObj |