TOTVSTEC

Árvore de páginas

Configura o uso da Fila usando como infra estrutura o Redis para mantê-la e permite a configuração dos parâmetros de temporização de tratamento e de manutenção das mensagens.

Se a fila não existir ela será criada se o setup retornar OK.
 

Sintaxe


nRet := oTQLS:Setup(cHost, nPort [, cAuth] [, nMsgRetPeriod] [, nVisibTimeOut])

Parâmetros

NomeTipoDescriçãoObrigatórioDefaultReferênciaObservações
cHostcaractere

Nome ou IP do servidor onde está configurado o Redis

X


nPortnuméricoNúmero da porta no servidor onde está configurado o RedisX


cAuthcaractere

Senha de autenticação do Redis, quando configurado no serviço


Nil

Este campo foi inserido para versões superioriores "7.00.131227A-20180417 NG".

nMsgRetPeriodnumérico

Tempo de retenção de uma mensagem na Lista em segundos

(Tempo de armazenamento de Mensagem não tratada)


1209600

Se uma mensagem não retirada da fila ficar mais que este tempo, ela será descartada.

Mínimo permitido 60 segundos, máximo permitido 14 dias (1209600 segundos).

nVisibTimeOut
numérico

Tempo de espera de tratamento de mensagem em segundos

(Tempo de tratamento da Mensagem)


45

Se a mensagem retirada na Fila não for tratada e removida até este tempo, ela será colocada na Fila novamente para tratamento.

Mínimo permitido 5 segundos, máximo permitido 12 horas (43200 segundos).

Retorno

NomeTipoDescriçãoObservações
nRetnumérico

Contem o a indicação do erro ou 0 (zero) se OK




Observações

  • Se nMsgRetPeriod não for informado (Nil) ou se tiver valor igual a 0 (zero), nMsgRetPeriod usará o valor default, todavia se nMsgRetPeriod for passado como -1, a fila irá recuperar o valor de nMsgRetPeriod de uma fila previamente criada, não alterando assim o valor já registrado nesta fila.

  •  Se nVisibTimeOut não for informado (Nil) ou se tiver valor igual a 0 (zero), nVisibTimeOut usará o valor default, todavia se nVisibTimeOut for passado como -1,  irá recuperar o valor de nVisibTimeOut de uma fila previamente criada, não alterando assim o valor já registrado nesta fila.

  • Obs. se a fila não tiver sido criada previamente e nMsgRetPeriod e/ou nVisibTimeOut forem passado como -1, os valores recuperados serão os valores padrão para criação de Filas da SQS.

  • AVISO: Não é demais reforçar que os tempos de visibilidade devem ser ajustados de acordo com o comportamento do aplicativo onde as filas serão usadas.

    Tempos de visibilidade menores do que o tempo necessário para que a aplicação remova uma mensagem da fila farão com que a mensagem retorne para a fila e possa ser novamente recebida.

Exemplos

Exemplo 1 

Exemplo 2 

Exemplo 3 



Veja também

  • Sem rótulos