Mudanças entre as edições de "Variáveis Core"

De opensipsbrasil - wiki
Ir para navegação Ir para pesquisar
 
(5 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 31: Linha 31:
  
 
Exemplo de uso:
 
Exemplo de uso:
* Only '''name''': %green%$ru
 
* '''Name''' and '''subname'': %green%$hdr(Contact)%%
 
* '''Name''' and '''index''': %green%$(ct[0])%%
 
* '''Name''', '''subname''' and '''index''': %green%$(avp(i:10)[2])
 
* '''Context'''
 
** %green%$(<request>ru)%% from a reply route will get the Request-URI from the request
 
** %green%$(<reply>hdr(Contact))%% context can be used from failure route to access information from the reply
 
  
 +
* Apenas '''name''': $ru
 +
* '''Name''' e '''subname''': $hdr(Contact)
 +
* '''Name''' e '''index''': $(ct[0])
 +
* '''Name''', '''subname''' e '''index''': $(avp(i:10)[2])
 +
* '''Context'''
 +
** $(<request>ru) de uma rota reply irá receber a Request-URI da requisição
 +
** $(<reply>hdr(contact)) , contexto pode ser utilizado em uma rota de falha para acessar as informações do reply.
  
Types of variables:
+
==Tipos de variáveis==
  
* [[#varscript | '''script variables''']] - as the name says, these variables are strictly bound to the script routes. The variables are visible only in the routing blocks - they are not message or transaction related, but they are process related (script variables will be inherited by script routes executed by the same '''OpenSIPS''' process).\\
+
===script variables===
Script variables are read write and they can have integer or string values. A script variable can have only a single value. A new assignment (or write operation) will overwrite the existing value.
+
* Como o nome diz, estas variáveis são estritamente utilizadas em rotas de script, estas variáveis são visiveis apenas nos blocos de roteamento, não existem mensagem ou transações relacionas, mas são processos relacionados (variaveis de script são dependentes de rotas executadas pelo mesmo processo do '''OpenSIPS''').
  
* [[#varavps | '''AVP - Attribute Value Pair''']] - the AVPs are dynamic variables (as name) that can be created - the AVPS are linked to a singular message or transaction (if stateful processing is used). A message or a transaction will initially (when received or created) have an empty list of AVPS attached to it. During the routing script, the script directly or functions called from script may create new AVPS that will automatically attached to the message/transaction. The AVPS will be visible in all routes where any message (reply or request) of the transaction will be processed - branch_route , failure_route, onreply_route (for this last route you need to enable the TM parameter ''onreply_avp_mode'').\\
+
Variáveis de scripts são de leitura e escrita e podem ter valores inteiros ou strings, uma variável de script pode ter apenas um valor, uma nova atribuição (ou escrita) irá sobrescrever os valores existentes.
AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).
 
  
* [[#varpv | '''pseudo variables''']] - pseudo-variables (or PV) provide access to information from the processed SIP message (headers, RURI, transport level info, a.s.o) or from '''OpenSIPS''' inners (time values, process PID, return code of a function). Depending of what info they provide, the PVs are either bound to the message, either to nothing  (global). Most of the PVs are read-only and only several allow write operations. A PV may return several values or only one, depending of the referred info (if can have multiple values or not).\\
+
===AVP - Atribute Value Pair===
Standard PV is read-only and returns a single value (if not otherwise documented).
+
* As avp's são variaveis dinamicas que podem ser criadas, as avp's são linkadas para uma mensagem singular ou uma transação ( se processamento stateful está em uso), uma mensagem ou transação irá inicialmente (quando recebida ou criada) ter uma lista vazia de avp's atreladas, durante o processo de roteamento o script diretamente ou via função poderá criar novos AVP's que automaticamente serão atrelados a mensagem/transação, as avp's serão visiveis em todas as rotas onde qualquer mensagem (reply ou request) da transação seja processada, branch_route, filure_route, onreply_route ( para onreply_route voce deve ter ativado o parametro ''onreply_avp_mode'').
  
* [[#varesc | '''escape sequences''']] - escape sequences used to format the strings; they are actually not variables, but rather formatters.
+
AVP's são variáveis de leitura e escrita e uma AVP existente pode ser deletada (removida), uma AVP pode conter multiplos valores, uma nova atribuição (operação de escrita) irá adicionar o novo valor para a AVP, os valores são mantidos no formado ''ultimo adicionado é o primeiro a ser utilizado'' .
  
 +
===pseudo variables===
 +
* pseudo-variáveis (ou PV's) provem acesso a informação das mensagens SIP processadas (cabeçalhos, RURI, informações de trnasporte, etc..) ou de informações do '''OpenSIPS''' (valores de timers, números de processo (PID), códigos de retorno de função).
  
 +
Dependendo da informação provida a PV fica presa (relacionada) a um amensagem ou a nada (global), a maior parte das PV's são apenas de leitura, apenas algumas suportam operações de escrita, uma PV pode retornar varios ou apenas um valor dependendo da informação referenciadas (se pode ter valores multiplos ou nao)
  
[[#varscript]]
+
PV padrões são apenas de leitura e retornam apenas um valor (se não foi documentado de forma diferente)
!!!Script variables
 
  
'''Naming''': **$var(name)**
 
  
'''Hints''':
+
[[escape sequences]]
# if you want to start using a script variable in a route, better initialize it with same value (or reset it), otherwise you may inherit a value from a previous route that was executed by the same process.
+
 
# script variables are faster the AVPs, being referenced directly to memory location.
+
* Sequencias de escape são utilizadas para formatar strings, estas não são variaveis mas podem ser formatadas.
# the value of script variables persists over a '''OpenSIPS''' process.
+
 
 +
==Definições==
 +
 
 +
===Script Variables===
 +
 
 +
'''Nominação: **$var(name)**
 +
 
 +
'''Dicas''':
 +
 
 +
* Se você quer utilizar uma variavel em uma rota é melhor inicializar ou restar a mesma), de outra forma você poderá ter problemas com valores de rotas anteriores que forão executadas por um mesmo processo.
 +
* Variáveis de script são mais rápidas que AVP's sendo processadas diretamente no endereço de memória.
 +
* O valor de uma variável de script persiste para o processo do '''OpenSIPS'''
 +
* Um variável pode ter apenas um valor
 +
 
 
# a script value can have only one value.
 
# a script value can have only one value.
  
Example of usage:
+
Exemplos de uso
  
[@
+
<pre>
 
$var(a) = 2;  # sets the value of variable 'a' to integer '2'
 
$var(a) = 2;  # sets the value of variable 'a' to integer '2'
 
$var(a) = "2";  # sets the value of variable 'a' to string '2'
 
$var(a) = "2";  # sets the value of variable 'a' to string '2'
Linha 78: Linha 91:
 
   xlog("var a has third bit set\n");
 
   xlog("var a has third bit set\n");
 
}
 
}
@]
+
</pre>
  
Setting a variable to NULL is actually initializing the value to integer '0'. Script variables don't have NULL value.
+
Definir uma variável para NULL corresponde a iniciar a a mesma com valor '0', variáveis de script não possuem valor NULL.
  
  
 +
===AVP variables===
  
[[#varavps]]
+
'''Nominação''': **$avp(name)** ou **$(avp(name)[N])**
!!!AVP variables
 
  
'''Naming''': **$avp(name)** or **$(avp(name)[N])**
+
Quando utilizado o index 'N' você pode forçar a AVP para retornar um certo valor (valor na posição N), se nenhum index é informado o primeiro valor será o retornado.
  
When using the index "N" you can force the AVP to return a certain value (the N-th value). If no index is given, the first value will be returned.
 
  
'''Hints''':
+
'''Dicas''':
# to enable AVPs in onreply_route, use "modparam("tm", "onreply_avp_mode", 1)"
+
* Para ativar AVP's em onreply_route utilize '''modparam("tm", "onreply_avp_mode", 1)'''
# if multiple values are used for a single AVP, the values are index in revert order than added
+
* Se multiplos valores forem utilizados em uma mesma AVP os valores são indexados em ordem reversa (primeiro inserido é o ultimo da lista)
# AVPs are part of the transaction context, so they will be visible everywhere where the transaction is present.
+
* AVP's são parte do contexto de transação, desta forma estarão visiveis em todo local que a transação esteja presente.
# the value of an AVP can be deleted
+
* O valor de uma AVP pode ser deletado
  
Example of usage:
+
Exemplo de uso:
# Transaction persistence example
+
 
[@
+
Exemplo persistente a transação:
 +
 
 +
<pre>
 
# enable avps in onreply route
 
# enable avps in onreply route
 
modparam("tm", "onreply_avp_mode", 1)
 
modparam("tm", "onreply_avp_mode", 1)
Linha 118: Linha 132:
 
}
 
}
 
}
 
}
@]
+
</pre>
  
# Multilple values example
+
Exemplo com multiplos valores
[@
+
 
 +
<pre>
 
$avp(17) = "one";
 
$avp(17) = "one";
 
# we have a single value
 
# we have a single value
Linha 146: Linha 161:
 
#overwrite the value at a certain index
 
#overwrite the value at a certain index
 
$(avp(17)[0]) = "zero";
 
$(avp(17)[0]) = "zero";
@]
+
</pre>
  
The '''AVPOPS''' module provides a lot of useful functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc).
+
O módulo '''AVPOPS''' prove uma série de funções para operar as AVP's (como checagem de valores, extração em diferentes locais, deleção etc..)
  
  
 +
===Pseudo Variables===
  
[[#varpv]]
+
'''Nominação''': $name
!!!Pseudo Variables
 
  
'''Naming''': $name
+
'''Dicas''':
 +
* as PV podem ser utilizadas como parametros para diferentes funções e serão substituidas com o valor antes da execução da função
 +
* A maior part edas PV's são disponibilizadas pelo core do '''OpenSIPS''' porém existem vários módulos que exportas PV's (para tornar algumas informações especificas do módulo disponivel), verifique as documentações dos módulos para saber mais.
  
'''Hints''':
+
Váriaveis pré-definidas pelo core listadas em ordem alfabética.
# the PV tokens can be given as parameters to different script functions and they will be replaced with a value before the execution of the function.
 
# most of PVs are made available by '''OpenSIPS''' core, but there are also module exporting PV (to make available info specific to that module) - check the modules documentation.
 
  
 +
====URI in SIP Request's P-Asserted-Identity header====
  
Predefined (provided by core) PVs are listed in alphabetical order.
+
'''$ai''' - referencia a URI no cabeçalho P-Asserted-Identity  (veja  RFC 3325 para mais detalhes)
  
 +
====Authentication Digest URI====
  
!!!!URI in SIP Request's P-Asserted-Identity header
+
'''$adu''' - URI do cabeçalho Authorization ou Proxy-Authorization, esta URI é utilizada quando calculando a resposta do resposta do HTTP Digest (autenticação).
  
'''$ai''' - reference to URI in request's P-Asserted-Identity header (see RFC 3325)
+
====Authentication realm====
  
!!!!Authentication Digest URI
 
  
'''$adu''' - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response.
+
'''$ar''' - referencia (dominio ou ip) no cabeçalho de  Authorization ou Proxy-Authorization
  
!!!!Authentication realm
+
====Auth username user====
  
'''$ar''' - realm from Authorization or Proxy-Authorization header
+
'''$au''' - parte referente ao nome do usuário no cabeçalho de Authorization ou Proxy-Authorization
  
!!!!Auth username user
+
====Auth username domain====
  
'''$au''' - user part of username from Authorization or Proxy-Authorization header
+
'''$ad''' - parte referente ao dominio do usuário no cabeçalho de Authorization ou Proxy-Authorization
  
  
!!!!Auth username domain
+
====Auth nonce====
  
'''$ad''' - domain part of username from Authorization or Proxy-Authorization header
+
'''$an''' - Hash  do cebçalho Authorization ou Proxy-Authorization  
 +
Nota: na documentação fala nounce, não achei tradução para isso (ex de valor: nonce: 526442e200000000b8d49749e4bdd108e58cd246de209a50)
  
  
!!!!Auth nonce
+
====Auth response====
  
'''$an''' - the nonce from Authorization or Proxy-Authorization header
+
'''$auth.resp''' - A resposta da autenticação para um cabeçalho Authorization ou Proxy-Authorization
  
  
!!!!Auth response
+
====Auth nonce====
 
 
'''$auth.resp''' - the authentication response from Authorization or Proxy-Authorization header
 
 
 
 
 
!!!!Auth nonce  
 
  
 
'''$auth.nonce''' - the nonce string from Authorization or Proxy-Authorization header
 
'''$auth.nonce''' - the nonce string from Authorization or Proxy-Authorization header
  
  
!!!!Auth opaque
+
====Auth opaque====
  
 
'''$auth.opaque''' - the opaque string from Authorization or Proxy-Authorization header
 
'''$auth.opaque''' - the opaque string from Authorization or Proxy-Authorization header
  
  
!!!!Auth algorithm
+
====Auth algorithm====
  
'''$auth.alg''' - the algorithm string from Authorization or Proxy-Authorization header
+
'''$auth.alg''' - A string referente ao algoritimos utilizado para Authorization ou Proxy-Authorization.
  
 
 
!!!!Auth QOP
+
===Auth QOP===
  
'''$auth.qop''' - the value of qop parameter from Authorization or Proxy-Authorization header
+
'''$auth.qop''' - O valor do parametro qop (quality of protection) do caebaçalho Authorization ou Proxy-Authorization
  
  
!!!!Auth nonce count (nc)
+
====Auth nonce count (nc)====
  
 
'''$auth.nc''' - the value of nonce count parameter from Authorization or Proxy-Authorization header
 
'''$auth.nc''' - the value of nonce count parameter from Authorization or Proxy-Authorization header
  
  
!!!!Auth whole username
+
====Auth whole username====
  
'''$aU''' - whole username from Authorization or Proxy-Authorization header
+
'''$aU''' - Nome do usuário no cabeçalho Authorization or Proxy-Authorization
  
!!!!Acc username
+
====Acc username====
  
'''$Au''' - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.
+
'''$Au''' - usuário para proposito de accounting , é uma pseudo variavel seletiva (dependente do modulo acc) , se existir ela retorna seu valor ou retorna o valor do campo From em todo caso
  
!!!!Argument options
+
====Argument options====
 +
 
 +
'''$argv''' - Permite acesso a argumentos de linha de comando especificados com o parametro '''-o'''
 +
 
 +
Exemplo:
  
'''$argv''' - provides access to command line arguments specified with '-o' option.
 
Examples:
 
[@
 
 
   # for option '-o foo=0'
 
   # for option '-o foo=0'
 
   xlog("foo is $argv(foo) \n");
 
   xlog("foo is $argv(foo) \n");
@]
 
  
!!!!Branch flags
 
  
'''$bf''' - displays a list with the branch flags set for the current SIP request
+
====Branch flags====
 +
 
 +
'''$bf''' - Exibe a lista de branch flags definidas para a requisição atual
  
 
!!!!Branch flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%
 
!!!!Branch flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%
  
'''$bF''' - reference to branch flags - hexa output
 
  
!!!!Branch
 
  
'''$branch''' - this variable is used for creating new branches by writing into it the value of a SIP URI.
+
====Branch====
Examples:
+
 
[@
+
'''$branch''' - Esta variavel é utilizada para criação de novas branches (pernas) escrevendo as mesmas no valor da SIP URI
 +
Exemplos
 +
 
 +
 
 
   # creates a new branch
 
   # creates a new branch
 
   $branch = "sip:new@doamin.org";
 
   $branch = "sip:new@doamin.org";
 
   # print its URI
 
   # print its URI
 
   xlog("last added branch has URI $(branch(uri)[-1]) \n");
 
   xlog("last added branch has URI $(branch(uri)[-1]) \n");
@]
 
  
!!!!Branch fields
 
  
'''$branch()''' - this variable provides read/write access to all fields/attributes of an already existing branch (priorly created with append_branch() ). The fields of the branch are:
+
====Branch fields====
* uri - the RURI of the branch (string value)
+
 
* duri - destination URI of the branch (outbound proxy of the branch) (string value)
+
'''$branch()''' - Esta variavel permite acesso de leitura e escrita para todos os campos/atributos de uma branch existente (previamente criada com append_branch()), os campos da branche são:
* q - q value of the branch (int value)
+
 
* path - the PATH string for this branch (string value)
+
* uri - a RURI da branch (string)
* flags - the branch flags of this branch (int value)
+
* duri - a URI e destino da branch (proxy the saida da branch) (sting)
* socket - the local socket to be used for relaying this branch (string value)
+
* q - o valor '''q''' da branch (inteiro)
The variable accepts also index '''$(branch(uri)[1])''' for accessing a specific branch (multiple branches can be defined at a moment). The index starts from 0 (first branch). If the index is negative, it is considered the n-th branch from the end ( index -1 means the last branch).\\
+
* path - a string PATH desta branch (string)
To get all branches, use the * index - $(branch(uri)[*]).\\
+
* flags - as flags para esta branch (inteiro)
Examples:
+
* socket - o scoket local para ser utilizado para fazer o relay desta branch (string)
[@
+
 
 +
A variavel aceita também index '''$(branch(uri)[1])''' para acessar uma branch especifica (multiplas branches podem ser especificadas autalmente), o index inicia em 0 (primeira branch), se o index for negativo ele é considerado o valor n do fim ( index -1 é ultima branch)
 +
 
 +
Para todas as branches é utilizado o index '''*''' - $(branch(uri)[*]).
 +
 
 +
Exemplo:
 +
<pre>
 
   # creates the first branch
 
   # creates the first branch
 
   append_branch();
 
   append_branch();
Linha 287: Linha 305:
 
   $(branch(socket)[1]) = NULL;  # reset the socket of the second branch
 
   $(branch(socket)[1]) = NULL;  # reset the socket of the second branch
 
   $branch(duri) = NULL;  # reset the destination URI or the first branch
 
   $branch(duri) = NULL;  # reset the destination URI or the first branch
@]
+
</pre>
 +
 
 +
Esta é uma variavel de leitura e escrita (você pode definir valores apartir do script de roteamento)
 +
 
 +
 
 +
====Call-Id====
  
%red%It is R/W variable (you can assign values to it from routing logic)%%
+
'''$ci''' - Referencia para o valor do cabeçalho call-id
  
!!!!Call-Id
+
====Content-Length====
  
'''$ci''' - reference to body of call-id header
+
'''$cl''' - Referencia para o valor do cabeçalho content-length
  
!!!!Content-Length
+
====CSeq number====
  
'''$cl''' - reference to body of content-length header
+
'''$cs''' - Referencia ao valor do cabeçalho cseq
  
!!!!CSeq number
+
====Contact instance====
  
'''$cs''' - reference to cseq number from cseq header
+
'''$ct''' - referencia a 'contact instance/body' do cabeçalho contact, uma contact instance é o display_name + URI + contact_params, como um cabeçalho de contato pode conter multiplos valores e uma mensagem pode conter vários cabeçalhos, um index é adicionado a $ct neste caso:
  
!!!!Contact instance
+
* $ct -first  primeiro 'contact instance' da mensagem
 +
* $(ct[n]) - 'contact instance' na posição n do inicio da mensagem, iniciando com index 0
 +
* $(ct[-n]) - 'contact instance' na posição n apartir do fim da mensagem (iniciando em -1 (ultimo contato)
  
'''$ct''' - reference to contact instance/body from the contact header. A contact instance is  display_name + URI + contact_params. As a Contact header may contain multiple Contact instances and a message may contain multiple Contact headers, an index was added to the $ct variable:
+
=====Fields of a contact instance=====
* $ct -first contact instance from message
 
* $(ct[n]) - the n-th contact instance form the beginning of message, starting with index 0
 
* $(ct[-n]) - the n-th contact instance form the end of the message, starting with index -1 (the last contact instance)
 
  
!!!!Fields of a contact instance
+
A contact instance possue também campos que podem ser acessados
 +
 
 +
'''$ct.fields()''' - referencia os campos da 'contact instance' (veja abaixo)
 +
 
 +
Campos suportados são:
  
'''$ct.fields()''' - reference to the fields of a contact instance/body (see above). Supported fields are:
 
 
* name - display name
 
* name - display name
 
* uri - contact uri
 
* uri - contact uri
* q  - q param (value only)
+
* q  - parametro q (valor apenas)
* expires - expires param (value only)  
+
* expires - parametro expires (valor apenas)  
* methods - methods param (value only)
+
* methods - parametro metodo (valor apenas)
* received - received param (value only)
+
* received - parametro received (valor appenas)
* params - all params (including names)
+
* params - Todos os parametros (incluindo nomes)
 +
 
 +
Exemplos:
 +
* $ct.fields(uri) - URI da primeira 'contact instance'
 +
* $(ct.fields(name)[1]) - O display nae da segunda 'contact instance'
 +
 
 +
 
 +
====Content-Type====
  
Examples:
+
'''$cT''' - Referencia ao cabeçalho content-type
* $ct.fields(uri) - the URI of the first contact instance
 
* $(ct.fields(name)[1]) - the display name of the second contact instance
 
  
 +
====Domain of destination URI====
  
!!!!Content-Type
+
'''$dd''' - Referencia do dominio da destination uri
  
'''$cT''' - reference to body of content-type header
+
Esta é uma variável de leitura e escrita
  
!!!!Domain of destination URI
+
====Diversion header URI====
  
'''$dd''' - reference to domain of destination uri
+
'''$di''' - Referencia ao Diversion header URI
  
%red%It is R/W variable (you can assign values to it from routing logic)%%
+
====Diversion "privacy" parameter====
  
!!!!Diversion header URI
+
'''$dip''' - Referencia ao parametro 'privacy' do  Diversion header
  
'''$di''' - reference to Diversion header URI
+
====Diversion "reason" parameter====
  
!!!!Diversion "privacy" parameter
+
'''$dir''' - Referencia ao parametro 'reason' do  Diversion header
  
'''$dip''' - reference to Diversion header "privacy" parameter value
+
====Port of destination URI====
  
!!!!Diversion "reason" parameter
+
'''$dp''' - Referencia a porta da destination URI
  
'''$dir''' - reference to Diversion header "reason" parameter value
+
Váriavel de leitura e escrita
  
!!!!Port of destination URI
 
  
'''$dp''' - reference to port of destination uri
+
====Transport protocol of destination URI====
  
%red%It is R/W variable (you can assign values to it from routing logic)%%
+
'''$dP''' - referencia ao protocolo de transporte da destination uri
  
!!!!Transport protocol of destination URI
+
====Destination set====
  
'''$dP''' - reference to transport protocol of destination uri
+
'''$ds''' - referencia para a destination set
  
!!!!Destination set
+
====Destination URI====
  
'''$ds''' - reference to destination set
+
'''$du''' - referencia a destination uri (outbound proxy que deve ser utilizado para enviar a requisição), se a loose_route() retornar TRUE a destination uri é definida de acordo com o primeiro Route header
  
!!!!Destination URI
+
Esta é uma variável de leitura e escrita
  
'''$du''' - reference to destination uri (outbound proxy to be used for sending the request)
 
If loose_route() returns TRUE a destination uri is set according to the first Route header.
 
  
%red%It is R/W variable (you can assign values to it from routing logic)%%
+
====Error class====
  
!!!!Error class
+
'''$err.class''' - Classe de erro ( atualmente '1' )
  
'''$err.class''' - the class of error (now is '1' for parsing errors)
+
====Error level====
  
!!!!Error level
+
'''$err.level''' - Severidade da mensagem
  
'''$err.level''' - severity level for the error
+
====Error info====
  
!!!!Error info
+
'''$err.info''' - Texto descrevendo o erro
  
'''$err.info''' - text describing the error
+
====Error reply code====
  
!!!!Error reply code
+
'''$err.rcode''' - Reply code recomendado para o erro
  
'''$err.rcode''' - recommended reply code
+
====Error reply reason====
  
!!!!Error reply reason
+
'''$err.rreason''' - Reply reason (frase) recomendada para o erro
  
'''$err.rreason''' - recommended reply reason phrase
+
====From URI domain====
  
!!!!From URI domain
+
'''$fd''' - Referencia do dominio da URI do cabeçalho 'From'
  
'''$fd''' - reference to domain in URI of 'From' header
+
====From display name====
  
!!!!From display name
+
'''$fn''' - Referencia ao display name do cabeçalho 'From'
  
'''$fn''' - reference to display name of 'From' header
+
====Forced socket====
  
!!!!Forced socket
+
'''$fs''' - Referencia ao socket (forçado) para envio de mensagens (quando existe) , o formato é proto:ip:port
  
'''$fs''' - reference to the forced socket for message sending (if any) in the form proto:ip:port
+
Esta é uma variável de leitura e escrita
  
%red%It is R/W variable (you can assign values to it routing script)%%
 
  
!!!!From tag
+
====From tag====
  
'''$ft''' - reference to tag parameter of 'From' header
+
'''$ft''' - Referencia ao parametro tag do cabeçalho 'From'
  
!!!!From URI
+
====From URI====
  
'''$fu''' - reference to URI of 'From' header
+
'''$fu''' - referencia a URI do cabeçalho 'From'
  
!!!!From URI username
+
====From URI username====
  
'''$fU''' - reference to username in URI of 'From' header
+
'''$fU''' - referencia ao username da URI do cabeçalho 'From'
  
!!!!SIP message buffer
+
====SIP message buffer====
  
'''$mb''' - reference to SIP message buffer
+
'''$mb''' - Referencia para o SIP message buffer
  
!!!!Message Flags
+
====Message Flags====
  
'''$mf''' - displays a list with the message/transaction flags set for the current SIP request
+
'''$mf''' - Exibe uma lista com as flags utilizadas na mensagem ou transação para a requisição atual.
  
!!!!Message Flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%
 
  
'''$mF''' -reference to message/transaction flags set for current SIP request in hexa
+
====SIP message ID====
  
!!!!SIP message ID
+
'''$mi''' - Referencia ao ID da mensagem SIP
  
'''$mi''' - reference to SIP message id
+
====SIP message length====
  
!!!!SIP message length
+
'''$ml''' - Referenia ao tamanho da mensagem SIP
  
'''$ml''' - reference to SIP message length
+
====Domain in SIP Request's original URI====
  
!!!!Domain in SIP Request's original URI
+
'''$od''' - Referencia do dominio na R-URI original
  
'''$od''' - reference to domain in request's original R-URI
+
====Port of SIP request's original URI====
  
!!!!Port of SIP request's original URI
+
'''$op''' - Referencia a porta da R-URI original
  
'''$op''' - reference to port of original R-URI
+
====Transport protocol of SIP request original URI====
  
!!!!Transport protocol of SIP request original URI
+
'''$oP''' - Referencia do protocolo de transporte da R-URI original
  
'''$oP''' - reference to transport protocol of original R-URI
+
====SIP Request's original URI====
  
!!!!SIP Request's original URI
+
'''$ou''' - Referencia a URI da requisição original
  
'''$ou''' - reference to request's original URI
+
====Username in SIP Request's original URI====
  
!!!!Username in SIP Request's original URI
+
'''$oU''' - Referenciao ao username na requisição original
  
'''$oU''' - reference to username in request's original URI
+
====Route parameter====
 +
 
 +
'''$param(idx)''' - Recupera o parametro da rota , o index pode ser um inteiro ou uma pseudo-variavel (index inicia em 1)
 +
 
 +
Exemplo
  
!!!!Route parameter
 
'''$param(idx)''' - retrieves the parameters of the route. The index can be an integer, or a pseudo-variable (index starts at 1).\\
 
Example:
 
[@
 
 
   route {
 
   route {
 
       ...
 
       ...
Linha 470: Linha 496:
 
       xlog("$param(1): The parameter value is <$param($var(index))>\n");
 
       xlog("$param(1): The parameter value is <$param($var(index))>\n");
 
   }
 
   }
@]
 
  
!!!!Domain in SIP Request's P-Preferred-Identity header URI
+
====Domain in SIP Request's P-Preferred-Identity header URI====
 +
 
 +
'''$pd''' - Referencia ao dominio na URI do cabeçalho P-Preferred-Identity  (veja RFC 3325)
 +
 
 +
====Display Name in SIP Request's P-Preferred-Identity header====
 +
 
 +
'''$pn''' - Referencia ao display name no cabeçalho P-Preferred-Identity  (veja RFC 3325)
  
'''$pd''' - reference to domain in request's P-Preferred-Identity header URI (see RFC 3325)
+
====Process id====
  
!!!!Display Name in SIP Request's P-Preferred-Identity header
+
'''$pp''' - Referenciao ao processo id (pid)
  
'''$pn''' - reference to Display Name in request's P-Preferred-Identity header (see RFC 3325)
+
====Protocol of received message====
 +
'''$pr''' ou '''$proto''' - protocolo da mensagem recebida (UDP, TCP, TLS, SCTP)
  
!!!!Process id
+
====User in SIP Request's P-Preferred-Identity header URI====
  
'''$pp''' - reference to process id (pid)
+
'''$pU''' - referencia ao usuário da URI no cabeçalho  P-Preferred-Identity (veja RFC 3325)
  
!!!!Protocol of received message
+
====URI in SIP Request's P-Preferred-Identity header====
'''$pr''' or '''$proto''' - protocol of received message (UDP, TCP, TLS, SCTP)
 
  
!!!!User in SIP Request's P-Preferred-Identity header URI
+
'''$pu''' - Referencia a URI no cabeçalho P-Preferred-Identity (veja RFC 3325)
  
'''$pU''' - reference to user in request's P-Preferred-Identity header URI (see RFC 3325)
+
====Domain in SIP Request's URI====
  
!!!!URI in SIP Request's P-Preferred-Identity header
+
'''$rd''' - Referencia ao dominio da URI
  
'''$pu''' - reference to URI in request's P-Preferred-Identity header (see RFC 3325)
+
Esta é uma variável de leitura e escrita
  
!!!!Domain in SIP Request's URI
+
====Body of request/reply====
  
'''$rd''' - reference to domain in request's URI
+
'''$rb''' - Referencia ao corpo da mensagem recebida
  
%red%It is R/W variable (you can assign values to it routing script)%%
+
====Returned code====
  
!!!!Body of request/reply
+
'''$rc''' - Referencia do código de retorno da ultima função executada
  
'''$rb''' - reference to message body
+
'''$retcode''' - mesma coisa que **$rc**
  
!!!!Returned code
+
====Remote-Party-ID header URI====
  
'''$rc''' - reference to returned code by last invoked function
+
'''$re''' - referencia a URI do cabeçalho Remote-Party-ID
  
'''$retcode''' - same as **$rc**
+
====SIP request's method====
  
!!!!Remote-Party-ID header URI
+
'''$rm''' - Referencia ao método da mensagem atual
  
'''$re''' - reference to Remote-Party-ID header URI
+
====SIP request's port====
  
!!!!SIP request's method
+
'''$rp''' - Referencia a porta da R-URI
  
'''$rm''' - reference to request's method
+
Esta é uma váriavel de leitura e escrita.
  
!!!!SIP request's port
 
  
'''$rp''' - reference to port of R-URI
+
====Transport protocol of SIP request URI====
  
%red%It is R/W variable (you can assign values to it routing script)%%
+
'''$rP''' - Referencia ao protocolo de transporte da R-URI
  
!!!!Transport protocol of SIP request URI
+
====SIP reply's reason====
  
'''$rP''' - reference to transport protocol of R-URI
+
'''$rr''' - Referencia a '''reply's reason'''
  
!!!!SIP reply's reason
+
====SIP reply's status====
  
'''$rr''' - reference to reply's reason
+
'''$rs''' - Referencia ao status do reply
  
!!!!SIP reply's status
+
====Refer-to URI====
  
'''$rs''' - reference to reply's status
+
'''$rt''' - Referencia a URI do cabeçalho refer-to
  
!!!!Refer-to URI
+
====SIP Request's URI====
  
'''$rt''' - reference to URI of refer-to header
+
'''$ru''' - Referencia a request URI
  
!!!!SIP Request's URI
+
Esta é uma variável de leitura e escrita
  
'''$ru''' - reference to request's URI
 
  
%red%It is R/W variable (you can assign values to it routing script)%%
+
====Username in SIP Request's URI====
  
!!!!Username in SIP Request's URI
+
'''$rU''' - Referencia ao username da URI da requisição
  
'''$rU''' - reference to username in request's URI
+
Esta é uma variável de leitura e escrita
  
%red%It is R/W variable (you can assign values to it routing script)%%
+
====Q value of the SIP Request's URI====
  
!!!!Q value of the SIP Request's URI
+
'''$ru_q''' - Referencia ao valor 'q' da R-URI
  
'''$ru_q''' - reference to q value of the R-URI
+
Esta é uma variável de leitura e escrita
  
%red%It is R/W variable (you can assign values to it routing script)%%
+
====Received IP address====
  
!!!!Received IP address
+
'''$Ri''' - Referencia do IP da interface onde o pacote foi recebido
  
'''$Ri''' - reference to IP address of the interface where the request has been received
+
====Received port====
  
!!!!Received port
+
'''$Rp''' - Referencia da porta onde o pacote foi recebido
  
'''$Rp''' - reference to the port where the message was received
+
====Script flags====
  
!!!!Script flags
+
'''$sf''' - Exibe uma lista com as flgs de script da requisição atual
  
'''$sf''' - displays a list with the script flags set for the current SIP request
 
  
!!!!Script flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%
+
====IP source address====
  
'''$sF''' - reference to script flags - hexa output
+
'''$si''' - IP de origem da mensagem recebida
  
!!!!IP source address
+
====Source port====
  
'''$si''' - reference to IP source address of the message
+
'''$sp''' - Porta de origem da mensagme recebida
  
!!!!Source port
+
====To URI Domain====
  
'''$sp''' - reference to the source port of the message
+
'''$td''' - Referencia ao dominio da URI no cabeçalho 'To'
  
!!!!To URI Domain
+
====To display name====
  
'''$td''' - reference to domain in URI of 'To' header
+
'''$tn''' - Referencia ao display name no cabeçalho 'To'
  
!!!!To display name
+
====To tag====
  
'''$tn''' - reference to display name of 'To' header
+
'''$tt''' - Referencia ao parametro tag do cabeçalho 'To'
  
!!!!To tag
+
====To URI====
  
'''$tt''' - reference to tag parameter of 'To' header
+
'''$tu''' - Referencia a URI do cabeçalho 'To'
  
!!!!To URI
+
====To URI Username====
  
'''$tu''' - reference to URI of 'To' header
+
'''$tU''' - Referencia ao username da URI do cabeçalho 'To'
  
!!!!To URI Username
+
====Formatted date and time====
  
'''$tU''' - reference to username in URI of 'To' header
+
'''$time(format)''' - Retorna a string formatda de acordo com o comando date do UNIX (veja '''man date''')
  
!!!!Formatted date and time
+
====Branch index====
  
'''$time(format)''' - returns the string formatted time according to UNIX date (see: '''man date''').
+
'''$T_branch_idx''' - O index (iniciando com 1 para a primeira branche) da branch para qual é executada uma branch_route[], se utilizado fora da branch_route[] o valor será 0, esta variável é exportado pelo módulo TM.
  
!!!!Branch index
+
====Time Variables====
  
'''$T_branch_idx''' - the index (starting with 1 for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'. This is exported by TM module.
+
=====String formatted time=====
  
!!!!String formatted time
+
'''$Tf''' - Referencia a string formatda para hora (HH:MM:SS)
  
'''$Tf''' - reference string formatted time
+
=====Current unix time stamp in seconds=====
  
!!!!Current unix time stamp in seconds
+
'''$Ts''' - Referencia ao unix timestamp em segundos
  
'''$Ts''' - reference to current unix time stamp in seconds
+
=====Current microseconds of the current second=====
  
!!!!Current microseconds of the current second
+
'''$Tsm''' - Referencia para os microsegundos do segundo atual
  
'''$Tsm''' - reference to current microseconds of the current second
+
=====Startup unix time stamp=====
  
!!!!Startup unix time stamp
+
'''$TS''' - Referencia ao 'startup unix time stamp'
  
'''$TS''' - reference to startup unix time stamp
+
====User agent header====
  
!!!!User agent header
+
'''$ua''' - Referencia ao campo user agent do cabeçalho
  
'''$ua''' - reference to user agent header field
+
===SIP Headers===
  
!!!!SIP Headers
+
'''$(hdr(name)[N])''' - Representa o conteúdo do cabeçalho N identificado por 'name', se [N] for omitido então o conteúdo do primeiro cabeçalho será exibido, o primeiro cabeçalho é pego quando N=0, para o segundo N=1 e assim por diante, para imprimir o último cabeçalo  daquele tipo é possível utilizar o index [-1], nenhum outro valor negativo é suportado, não é permitido espaço em branco antes ou depois de [, {, }, ], quando N='*' , todos os cabeçalhos serão exibidos.
  
'''$(hdr(name)[N])''' - represents the body of the N-th header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.
+
O módulo deve identificar a maior parte dos cabeçalhos  compactos (o  '''OpenSIPS''' reconhece todos atualmente), se não a forma compacta do cabeçalho necessita ser especificada explicitamente, é recomendado usar identificadores especiais para os cabeçalhos (ex: %ua para user agent), se eles estiverem disponiveis pois são mais rapidos.
  
The module should identify most of compact header names (the ones recognized by '''OpenSIPS''' which should be all at this moment), if not, the compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster.
 
  
'''$(hdrcnt(name))''' -- returns number of headers of type given by 'name'. Uses same rules for specifying header names as '''$hdr(name)''' above. Many headers (e.g., Via, Path, Record-Route) may appear more than once in the message. This variable returns the number of headers of a given type.  
+
'''$(hdrcnt(name))''' -- Retorna o numero de cabeçalhos deste tipo existentes, o tipo é defnido por 'name', utiliza as mesmas regras de especificação de nome de cabeçalho como '''$hdr(name)''', muitos cabeçalhos (ex: Via, Path, Record-Route) podem aparecer mais de uma vez na mensagem, esta variavel então retorna o numero referente a quantidad ede vezes que o cabeçalho em questão está presente.
 +
 
 +
Veja que alguns cabeçalhos (ex: Path) pode ter valores com virgulas e aparecerem como uma unica linha, esta variavel conta a quantidade de linhas, e não a quantidade de valores
 +
 
 +
Para o fragmento de mensagem abaixo, '''$hdrcnt(Path)''' terá o valor 2 e '''$(hdr(Path)[0]''' terá o valor '''<a.com>''' ;
  
Note that some headers (e.g., Path) may be joined together with commas and appear as a single header line. This variable counts the number of header lines, not header values.
 
  
For message fragment below, '''$hdrcnt(Path)''' will have value 2 and '''$(hdr(Path)[0])''' will have value '''<a.com>''':
 
[@
 
 
     Path: <a.com>
 
     Path: <a.com>
 
     Path: <b.com>
 
     Path: <b.com>
@]
 
  
For message fragment below, '''$hdrcnt(Path)''' will have value 1 and '''$(hdr(Path)[0])''' will have value '''<a.com>,<b.com>''':
+
Para o fragmento de mensagem abaixo , '''$hdrcnt(Path)''' terá o valor 1, e '''$(hdr(Path)[0]''' terá o valor '''<a.com>,<b.com>'''
[@
+
 
 
     Path: <a.com>,<b.com>
 
     Path: <a.com>,<b.com>
@]
 
  
Note that both examples above are semantically equivalent but the variables take on different values.
+
Veja que os dois exemplos representam a mesma coisa mas as variaveis possuem valores diferentes
  
[[#varavps]]
 
  
!!!Escape Sequences
 
  
These sequences are exported, and mainly used, by xlog module to print messages in many colors (foreground and background) using escape sequences.
+
==Escape Sequences==
  
 +
Estas sequencias são exportadas e normalmente utilizadas pelo módulo xlog para exibir mensagens em várias cores (foreground ou background) usando sequencias de scape.
  
!!!!Foreground and background colors
 
  
 +
===Foreground and background colors===
  
$C(xy) - reference to an escape sequence. ¿x¿ represents the foreground color and ¿y¿ represents the background color.
 
  
Colors could be:
+
$C(xy) - Referencia uma sequencia de scape. 'x' repreenta a core de foreground (cor da fonte) e 'y' representa a cord de background (cor do fundo).
  
* x : default color of the terminal
+
Cores devem ser:
* s : Black
 
* r : Red
 
* g : Green
 
* y : Yellow
 
* b : Blue
 
* p : Purple
 
* c : Cyan
 
* w : White
 
  
 +
* x : Cor padrão do terminal
 +
* s : Preto
 +
* r : Vermelho
 +
* g : Verde
 +
* y : Amarelo
 +
* b : Azul
 +
* p : Roxo
 +
* c : Ciano
 +
* w : Branco
  
  
!!!!Examples
 
  
 +
Examplos:
  
A few examples of usage.
+
Alguns exemplos de uso
  
[@
+
<pre>
 
...
 
...
 
route {
 
route {
Linha 695: Linha 720:
 
}
 
}
 
...
 
...
@]
+
</pre>
 +
 
 +
[[OpenSIPS_1.9_Manual|Voltar]]

Edição atual tal como às 22h33min de 20 de outubro de 2013

O OpenSIPS prove varios tipos de variaveis para serem usados no script de roteamento, as diferenças entre os tipos de variaveis são:

  • 1. A visibilidade da variavel
  • 2. Onde a variavel é relacionada (onde a mesma reside)
  • 3. Status read-write da variavel ( algumas variaveis são apenas de leitura)
  • 4. Como multiplos valores (da mesma variavel) são manipulados.

As variáveis do OpenSIPS podem facilmente ser identificadas no script apartir de seus nomes (ou nota'ões) iniciando com o simbolo $

Sintaxe:

A sintaxe completa de uma pseudo-variavel é:

$(<context>name(subname)[index]{transformation})

Os campos context, subname, index e transformation são opcionais

Os campos significam:

  • name - o nome(tipo) da pseudo variavel.

Ex: pvar, avp, ru, DLG_status etc...

  • subname - o identificador de um certo tipo de variável.

Ex: hdr(From), avp(nome)

  • index - uma pv pode armazenar mais de um valor, isso pode ser referenciado a uma lista de valores, você pode acessar um certo valor de uma lista se você especificar o index, você também pode especificar indexe's negativos , -1 significa o ultimo inserido e -2 significa o valor anterior ao ultimo (penultimo).
  • transformation - uma série de processos que podem ser aplicados em pseudo-variaveis, você pode encontrar a lista completa em Transformações , as transformações podem ser cascateadas usango a saída de uma tranformação como entrada de outra.
  • context - o contexto onde a pseudo-variavel será verificada, atualmente existem dois contextos, reply e request, o contexto de reply pode ser usado na rota de falha para verificar o valor da pseudovariavel neste contexto , o contexto de request (requisição) pode ser usado quando em um contexto de reply é desejado a verificação do valor no contexto correspondente ao request.


Exemplo de uso:

  • Apenas name: $ru
  • Name e subname: $hdr(Contact)
  • Name e index: $(ct[0])
  • Name, subname e index: $(avp(i:10)[2])
  • Context
    • $(<request>ru) de uma rota reply irá receber a Request-URI da requisição
    • $(<reply>hdr(contact)) , contexto pode ser utilizado em uma rota de falha para acessar as informações do reply.

Índice

Tipos de variáveis

script variables

  • Como o nome diz, estas variáveis são estritamente utilizadas em rotas de script, estas variáveis são visiveis apenas nos blocos de roteamento, não existem mensagem ou transações relacionas, mas são processos relacionados (variaveis de script são dependentes de rotas executadas pelo mesmo processo do OpenSIPS).

Variáveis de scripts são de leitura e escrita e podem ter valores inteiros ou strings, uma variável de script pode ter apenas um valor, uma nova atribuição (ou escrita) irá sobrescrever os valores existentes.

AVP - Atribute Value Pair

  • As avp's são variaveis dinamicas que podem ser criadas, as avp's são linkadas para uma mensagem singular ou uma transação ( se processamento stateful está em uso), uma mensagem ou transação irá inicialmente (quando recebida ou criada) ter uma lista vazia de avp's atreladas, durante o processo de roteamento o script diretamente ou via função poderá criar novos AVP's que automaticamente serão atrelados a mensagem/transação, as avp's serão visiveis em todas as rotas onde qualquer mensagem (reply ou request) da transação seja processada, branch_route, filure_route, onreply_route ( para onreply_route voce deve ter ativado o parametro onreply_avp_mode).

AVP's são variáveis de leitura e escrita e uma AVP existente pode ser deletada (removida), uma AVP pode conter multiplos valores, uma nova atribuição (operação de escrita) irá adicionar o novo valor para a AVP, os valores são mantidos no formado ultimo adicionado é o primeiro a ser utilizado .

pseudo variables

  • pseudo-variáveis (ou PV's) provem acesso a informação das mensagens SIP processadas (cabeçalhos, RURI, informações de trnasporte, etc..) ou de informações do OpenSIPS (valores de timers, números de processo (PID), códigos de retorno de função).

Dependendo da informação provida a PV fica presa (relacionada) a um amensagem ou a nada (global), a maior parte das PV's são apenas de leitura, apenas algumas suportam operações de escrita, uma PV pode retornar varios ou apenas um valor dependendo da informação referenciadas (se pode ter valores multiplos ou nao)

PV padrões são apenas de leitura e retornam apenas um valor (se não foi documentado de forma diferente)


escape sequences

  • Sequencias de escape são utilizadas para formatar strings, estas não são variaveis mas podem ser formatadas.

Definições

Script Variables

Nominação: **$var(name)**

Dicas:

  • Se você quer utilizar uma variavel em uma rota é melhor inicializar ou restar a mesma), de outra forma você poderá ter problemas com valores de rotas anteriores que forão executadas por um mesmo processo.
  • Variáveis de script são mais rápidas que AVP's sendo processadas diretamente no endereço de memória.
  • O valor de uma variável de script persiste para o processo do OpenSIPS
  • Um variável pode ter apenas um valor
  1. a script value can have only one value.

Exemplos de uso

$var(a) = 2;  # sets the value of variable 'a' to integer '2'
$var(a) = "2";  # sets the value of variable 'a' to string '2'
$var(a) = 3 + (7&(~2)); # arithmetic and bitwise operation
$var(a) = "sip:" + $au + "@" + $fd; # compose a value from authentication username and From URI domain

# using a script variable for tests
if( [ $var(a) & 4 ] ) {
  xlog("var a has third bit set\n");
}

Definir uma variável para NULL corresponde a iniciar a a mesma com valor '0', variáveis de script não possuem valor NULL.


AVP variables

Nominação: **$avp(name)** ou **$(avp(name)[N])**

Quando utilizado o index 'N' você pode forçar a AVP para retornar um certo valor (valor na posição N), se nenhum index é informado o primeiro valor será o retornado.


Dicas:

  • Para ativar AVP's em onreply_route utilize modparam("tm", "onreply_avp_mode", 1)
  • Se multiplos valores forem utilizados em uma mesma AVP os valores são indexados em ordem reversa (primeiro inserido é o ultimo da lista)
  • AVP's são parte do contexto de transação, desta forma estarão visiveis em todo local que a transação esteja presente.
  • O valor de uma AVP pode ser deletado

Exemplo de uso:

Exemplo persistente a transação:

# enable avps in onreply route
modparam("tm", "onreply_avp_mode", 1)
...
route{
...
$avp(tmp) = $Ts ; # store the current time (at request processing)
...
t_onreply("1");
t_relay();
...
}

onreply_route[1] {
	if (t_check_status("200")) {
		# calculate the setup time
		$var(setup_time) = $Ts - $avp(tmp);
	}
}

Exemplo com multiplos valores

$avp(17) = "one";
# we have a single value
$avp(17) = "two";
# we have two values ("two","one")
$avp(17) = "three";
# we have three values ("three","two","one")

xlog("accessing values with no index: $avp(17)\n");
# this will print the first value, which is the last added value -> "three"

xlog("accessing values with no index: $(avp(17)[2])\n");
# this will print the index 2 value (third one), -> "one"

# remove the last value of the avp; if there is only one value, the AVP itself will be destroyed
$avp(17) = NULL;

# delete all values and destroy the AVP
avp_delete("$avp(17)/g");

# delete the value located at a certain index 
$(avp(17)[1]) = NULL;

#overwrite the value at a certain index
$(avp(17)[0]) = "zero";

O módulo AVPOPS prove uma série de funções para operar as AVP's (como checagem de valores, extração em diferentes locais, deleção etc..)


Pseudo Variables

Nominação: $name

Dicas:

  • as PV podem ser utilizadas como parametros para diferentes funções e serão substituidas com o valor antes da execução da função
  • A maior part edas PV's são disponibilizadas pelo core do OpenSIPS porém existem vários módulos que exportas PV's (para tornar algumas informações especificas do módulo disponivel), verifique as documentações dos módulos para saber mais.

Váriaveis pré-definidas pelo core listadas em ordem alfabética.

URI in SIP Request's P-Asserted-Identity header

$ai - referencia a URI no cabeçalho P-Asserted-Identity (veja RFC 3325 para mais detalhes)

Authentication Digest URI

$adu - URI do cabeçalho Authorization ou Proxy-Authorization, esta URI é utilizada quando calculando a resposta do resposta do HTTP Digest (autenticação).

Authentication realm

$ar - referencia (dominio ou ip) no cabeçalho de Authorization ou Proxy-Authorization

Auth username user

$au - parte referente ao nome do usuário no cabeçalho de Authorization ou Proxy-Authorization

Auth username domain

$ad - parte referente ao dominio do usuário no cabeçalho de Authorization ou Proxy-Authorization


Auth nonce

$an - Hash do cebçalho Authorization ou Proxy-Authorization Nota: na documentação fala nounce, não achei tradução para isso (ex de valor: nonce: 526442e200000000b8d49749e4bdd108e58cd246de209a50)


Auth response

$auth.resp - A resposta da autenticação para um cabeçalho Authorization ou Proxy-Authorization


Auth nonce

$auth.nonce - the nonce string from Authorization or Proxy-Authorization header


Auth opaque

$auth.opaque - the opaque string from Authorization or Proxy-Authorization header


Auth algorithm

$auth.alg - A string referente ao algoritimos utilizado para Authorization ou Proxy-Authorization.


Auth QOP

$auth.qop - O valor do parametro qop (quality of protection) do caebaçalho Authorization ou Proxy-Authorization


Auth nonce count (nc)

$auth.nc - the value of nonce count parameter from Authorization or Proxy-Authorization header


Auth whole username

$aU - Nome do usuário no cabeçalho Authorization or Proxy-Authorization

Acc username

$Au - usuário para proposito de accounting , é uma pseudo variavel seletiva (dependente do modulo acc) , se existir ela retorna seu valor ou retorna o valor do campo From em todo caso

Argument options

$argv - Permite acesso a argumentos de linha de comando especificados com o parametro -o

Exemplo:

  # for option '-o foo=0'
  xlog("foo is $argv(foo) \n");


Branch flags

$bf - Exibe a lista de branch flags definidas para a requisição atual

!!!!Branch flags (hexadecimal) %red%(Removed in OpenSIPS 1.9)%%


Branch

$branch - Esta variavel é utilizada para criação de novas branches (pernas) escrevendo as mesmas no valor da SIP URI Exemplos


  # creates a new branch
  $branch = "sip:new@doamin.org";
  # print its URI
  xlog("last added branch has URI $(branch(uri)[-1]) \n");


Branch fields

$branch() - Esta variavel permite acesso de leitura e escrita para todos os campos/atributos de uma branch existente (previamente criada com append_branch()), os campos da branche são:

  • uri - a RURI da branch (string)
  • duri - a URI e destino da branch (proxy the saida da branch) (sting)
  • q - o valor q da branch (inteiro)
  • path - a string PATH desta branch (string)
  • flags - as flags para esta branch (inteiro)
  • socket - o scoket local para ser utilizado para fazer o relay desta branch (string)

A variavel aceita também index $(branch(uri)[1]) para acessar uma branch especifica (multiplas branches podem ser especificadas autalmente), o index inicia em 0 (primeira branch), se o index for negativo ele é considerado o valor n do fim ( index -1 é ultima branch)

Para todas as branches é utilizado o index * - $(branch(uri)[*]).

Exemplo:

   # creates the first branch
   append_branch();
   # creates the second branch
   force_send_socket(udp:192.168.1.10:5060);
   $du = "sip:192.168.2.10";
   append_branch("sip:foo@bar.com","0.5");

   # display branches
   xlog("----- branch 0: $(branch(uri)[0]) , $(branch(q)[0]), $(branch(duri)[0]), $(branch(path)[0]), $(branch(flags)[0]), $(branch(socket)[0]) \n");
   xlog("----- branch 1: $(branch(uri)[1]) , $(branch(q)[1]), $(branch(duri)[1]), $(branch(path)[1]), $(branch(flags)[1]), $(branch(socket)[1]) \n");

   # do some changes over the branches
   $branch(uri) = "sip:user@domain.ro";   # set URI for the first branch
   $(branch(q)[0]) = 1000;  # set to 1.00 for the first branch
   $(branch(socket)[1]) = NULL;  # reset the socket of the second branch
   $branch(duri) = NULL;  # reset the destination URI or the first branch

Esta é uma variavel de leitura e escrita (você pode definir valores apartir do script de roteamento)


Call-Id

$ci - Referencia para o valor do cabeçalho call-id

Content-Length

$cl - Referencia para o valor do cabeçalho content-length

CSeq number

$cs - Referencia ao valor do cabeçalho cseq

Contact instance

$ct - referencia a 'contact instance/body' do cabeçalho contact, uma contact instance é o display_name + URI + contact_params, como um cabeçalho de contato pode conter multiplos valores e uma mensagem pode conter vários cabeçalhos, um index é adicionado a $ct neste caso:

  • $ct -first primeiro 'contact instance' da mensagem
  • $(ct[n]) - 'contact instance' na posição n do inicio da mensagem, iniciando com index 0
  • $(ct[-n]) - 'contact instance' na posição n apartir do fim da mensagem (iniciando em -1 (ultimo contato)
Fields of a contact instance

A contact instance possue também campos que podem ser acessados

$ct.fields() - referencia os campos da 'contact instance' (veja abaixo)

Campos suportados são:

  • name - display name
  • uri - contact uri
  • q - parametro q (valor apenas)
  • expires - parametro expires (valor apenas)
  • methods - parametro metodo (valor apenas)
  • received - parametro received (valor appenas)
  • params - Todos os parametros (incluindo nomes)

Exemplos:

  • $ct.fields(uri) - URI da primeira 'contact instance'
  • $(ct.fields(name)[1]) - O display nae da segunda 'contact instance'


Content-Type

$cT - Referencia ao cabeçalho content-type

Domain of destination URI

$dd - Referencia do dominio da destination uri

Esta é uma variável de leitura e escrita

Diversion header URI

$di - Referencia ao Diversion header URI

Diversion "privacy" parameter

$dip - Referencia ao parametro 'privacy' do Diversion header

Diversion "reason" parameter

$dir - Referencia ao parametro 'reason' do Diversion header

Port of destination URI

$dp - Referencia a porta da destination URI

Váriavel de leitura e escrita


Transport protocol of destination URI

$dP - referencia ao protocolo de transporte da destination uri

Destination set

$ds - referencia para a destination set

Destination URI

$du - referencia a destination uri (outbound proxy que deve ser utilizado para enviar a requisição), se a loose_route() retornar TRUE a destination uri é definida de acordo com o primeiro Route header

Esta é uma variável de leitura e escrita


Error class

$err.class - Classe de erro ( atualmente '1' )

Error level

$err.level - Severidade da mensagem

Error info

$err.info - Texto descrevendo o erro

Error reply code

$err.rcode - Reply code recomendado para o erro

Error reply reason

$err.rreason - Reply reason (frase) recomendada para o erro

From URI domain

$fd - Referencia do dominio da URI do cabeçalho 'From'

From display name

$fn - Referencia ao display name do cabeçalho 'From'

Forced socket

$fs - Referencia ao socket (forçado) para envio de mensagens (quando existe) , o formato é proto:ip:port

Esta é uma variável de leitura e escrita


From tag

$ft - Referencia ao parametro tag do cabeçalho 'From'

From URI

$fu - referencia a URI do cabeçalho 'From'

From URI username

$fU - referencia ao username da URI do cabeçalho 'From'

SIP message buffer

$mb - Referencia para o SIP message buffer

Message Flags

$mf - Exibe uma lista com as flags utilizadas na mensagem ou transação para a requisição atual.


SIP message ID

$mi - Referencia ao ID da mensagem SIP

SIP message length

$ml - Referenia ao tamanho da mensagem SIP

Domain in SIP Request's original URI

$od - Referencia do dominio na R-URI original

Port of SIP request's original URI

$op - Referencia a porta da R-URI original

Transport protocol of SIP request original URI

$oP - Referencia do protocolo de transporte da R-URI original

SIP Request's original URI

$ou - Referencia a URI da requisição original

Username in SIP Request's original URI

$oU - Referenciao ao username na requisição original

Route parameter

$param(idx) - Recupera o parametro da rota , o index pode ser um inteiro ou uma pseudo-variavel (index inicia em 1)

Exemplo

  route {
     ...
     $var(debug) = "DBUG:"
     route(PRINT_VAR, $var(debug), "param value");
     ...
  }
  route[PRINT_VAR] {
     $var(index) = 2;
     xlog("$param(1): The parameter value is <$param($var(index))>\n");
  }

Domain in SIP Request's P-Preferred-Identity header URI

$pd - Referencia ao dominio na URI do cabeçalho P-Preferred-Identity (veja RFC 3325)

Display Name in SIP Request's P-Preferred-Identity header

$pn - Referencia ao display name no cabeçalho P-Preferred-Identity (veja RFC 3325)

Process id

$pp - Referenciao ao processo id (pid)

Protocol of received message

$pr ou $proto - protocolo da mensagem recebida (UDP, TCP, TLS, SCTP)

User in SIP Request's P-Preferred-Identity header URI

$pU - referencia ao usuário da URI no cabeçalho P-Preferred-Identity (veja RFC 3325)

URI in SIP Request's P-Preferred-Identity header

$pu - Referencia a URI no cabeçalho P-Preferred-Identity (veja RFC 3325)

Domain in SIP Request's URI

$rd - Referencia ao dominio da URI

Esta é uma variável de leitura e escrita

Body of request/reply

$rb - Referencia ao corpo da mensagem recebida

Returned code

$rc - Referencia do código de retorno da ultima função executada

$retcode - mesma coisa que **$rc**

Remote-Party-ID header URI

$re - referencia a URI do cabeçalho Remote-Party-ID

SIP request's method

$rm - Referencia ao método da mensagem atual

SIP request's port

$rp - Referencia a porta da R-URI

Esta é uma váriavel de leitura e escrita.


Transport protocol of SIP request URI

$rP - Referencia ao protocolo de transporte da R-URI

SIP reply's reason

$rr - Referencia a reply's reason

SIP reply's status

$rs - Referencia ao status do reply

Refer-to URI

$rt - Referencia a URI do cabeçalho refer-to

SIP Request's URI

$ru - Referencia a request URI

Esta é uma variável de leitura e escrita


Username in SIP Request's URI

$rU - Referencia ao username da URI da requisição

Esta é uma variável de leitura e escrita

Q value of the SIP Request's URI

$ru_q - Referencia ao valor 'q' da R-URI

Esta é uma variável de leitura e escrita

Received IP address

$Ri - Referencia do IP da interface onde o pacote foi recebido

Received port

$Rp - Referencia da porta onde o pacote foi recebido

Script flags

$sf - Exibe uma lista com as flgs de script da requisição atual


IP source address

$si - IP de origem da mensagem recebida

Source port

$sp - Porta de origem da mensagme recebida

To URI Domain

$td - Referencia ao dominio da URI no cabeçalho 'To'

To display name

$tn - Referencia ao display name no cabeçalho 'To'

To tag

$tt - Referencia ao parametro tag do cabeçalho 'To'

To URI

$tu - Referencia a URI do cabeçalho 'To'

To URI Username

$tU - Referencia ao username da URI do cabeçalho 'To'

Formatted date and time

$time(format) - Retorna a string formatda de acordo com o comando date do UNIX (veja man date)

Branch index

$T_branch_idx - O index (iniciando com 1 para a primeira branche) da branch para qual é executada uma branch_route[], se utilizado fora da branch_route[] o valor será 0, esta variável é exportado pelo módulo TM.

Time Variables

String formatted time

$Tf - Referencia a string formatda para hora (HH:MM:SS)

Current unix time stamp in seconds

$Ts - Referencia ao unix timestamp em segundos

Current microseconds of the current second

$Tsm - Referencia para os microsegundos do segundo atual

Startup unix time stamp

$TS - Referencia ao 'startup unix time stamp'

User agent header

$ua - Referencia ao campo user agent do cabeçalho

SIP Headers

$(hdr(name)[N]) - Representa o conteúdo do cabeçalho N identificado por 'name', se [N] for omitido então o conteúdo do primeiro cabeçalho será exibido, o primeiro cabeçalho é pego quando N=0, para o segundo N=1 e assim por diante, para imprimir o último cabeçalo daquele tipo é possível utilizar o index [-1], nenhum outro valor negativo é suportado, não é permitido espaço em branco antes ou depois de [, {, }, ], quando N='*' , todos os cabeçalhos serão exibidos.

O módulo deve identificar a maior parte dos cabeçalhos compactos (o OpenSIPS reconhece todos atualmente), se não a forma compacta do cabeçalho necessita ser especificada explicitamente, é recomendado usar identificadores especiais para os cabeçalhos (ex: %ua para user agent), se eles estiverem disponiveis pois são mais rapidos.


$(hdrcnt(name)) -- Retorna o numero de cabeçalhos deste tipo existentes, o tipo é defnido por 'name', utiliza as mesmas regras de especificação de nome de cabeçalho como $hdr(name), muitos cabeçalhos (ex: Via, Path, Record-Route) podem aparecer mais de uma vez na mensagem, esta variavel então retorna o numero referente a quantidad ede vezes que o cabeçalho em questão está presente.

Veja que alguns cabeçalhos (ex: Path) pode ter valores com virgulas e aparecerem como uma unica linha, esta variavel conta a quantidade de linhas, e não a quantidade de valores

Para o fragmento de mensagem abaixo, $hdrcnt(Path) terá o valor 2 e $(hdr(Path)[0] terá o valor <a.com> ;


   Path: <a.com>
   Path: <b.com>

Para o fragmento de mensagem abaixo , $hdrcnt(Path) terá o valor 1, e $(hdr(Path)[0] terá o valor <a.com>,<b.com>

   Path: <a.com>,<b.com>

Veja que os dois exemplos representam a mesma coisa mas as variaveis possuem valores diferentes


Escape Sequences

Estas sequencias são exportadas e normalmente utilizadas pelo módulo xlog para exibir mensagens em várias cores (foreground ou background) usando sequencias de scape.


Foreground and background colors

$C(xy) - Referencia uma sequencia de scape. 'x' repreenta a core de foreground (cor da fonte) e 'y' representa a cord de background (cor do fundo).

Cores devem ser:

  • x : Cor padrão do terminal
  • s : Preto
  • r : Vermelho
  • g : Verde
  • y : Amarelo
  • b : Azul
  • p : Roxo
  • c : Ciano
  • w : Branco


Examplos:

Alguns exemplos de uso

...
route {
...
    $avp(uuid)="caller_id";
    $avp(tmp)= $avp(uuid) + ": " + $fu;
    xdbg("$(C(bg))avp(tmp)$(C(xx)) [$avp(tmp)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n");
...
}
...

Voltar