XFL and Python API

get_absolute_time

get_absolute_time ()

Returns time in milliseconds elapsed since 00:00:00 UTC 1 January 1970. Differs from “gettime” API and “gettime” function in XFL Formulas in the following points:

• Time is relative to 00:00:00 UTC 1 January 1970 (instead of the start of the script)
• More precise
• Can be significantly slower on some machines, and should be used judiciously

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• None

encode

encode (data1 [, data2[, …]] [, mode])

Encodes data element–usually a whole message–into a bit string

Callable from:

• XFL
• Python

Arguments

mode flags

Return Value

• Encoded packet

Return Type

• Bit string

Python Example:

# Encoding 4 layers together into a binary

isup, sigtr, sctp, ipv4 = Build_ISUP_IAM(), Build_M3UA_DATA(), Build_SCTP_Packet(), Build_IPv4_Frame()

binaryData = sk.encode(isup, sigtr, sctp, ipv4)

seedrandom

seedrandom ([seed])

Restarts the pseudo-random sequence generated by rand(). The sequence is also implicitly restarted when Packet Studio starts, and in the beginning of XFL execution.
Affects receive() in random mode (see ‘Settings.ReceiveSide.Random mode’ on ‘Vars’ page). This call doesn’t affect language-specific random generation.

Callable from:

• XFL
• Python

Arguments

Return Value

• None

getdir

getdir ()

Returns the script directory

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• Absolute path to the location of the calling script

Return Type

• Text string

getexamplesdir

getexamplesdir ()

Returns the absolute path to ‘Examples’ folder

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• Absolute path to ‘Examples’ folder

Return Type

• Text string

getworkspacedir

getworkspacedir ()

Returns the script directory

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• Absolute path to ‘Workspace’ folder

Return Type

• Text string

getcommondir

getcommondir ()

Returns the script directory

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• Absolute path to ‘Common’ folder

Return Type

• Text string

rtp_create_session

rtp_create_session (local-host, local-port [, remote-host] [, remote-port] [, flags])

Creates an RTP session

Callable from:

• XFL
• Python

Arguments

flags values

Return Value

• New sesson id on success, -1 on failure.

Return Type

• Integer

Python Example:

rtpSessionId = sk.rtp_create_session(SourceIPAddress, SourceRTPPort, remoteIPPort, remoteRTPPort)

rtp_set_session_remote_addr

rtp_set_session_remote_addr (session-id, remote-host, remote-port)

Sets remote address and port for an RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_tx_init_srtp

rtp_tx_init_srtp (session-id, cipher-type, cipher-key-len, auth-type, auth-key-len, auth-tag-len, key)

Initialize SRTP in the outgoing direction

Callable from:

• XFL
• Python

Arguments

cypher_type values

auth_type values

Return Value

• None

Python Example:

sk.srtp_tx_init_srtp(rtpSessionId, 1, 30, 3, 20, 10, secret)

rtp_rx_init_srtp

rtp_rx_init_srtp (session-id, cipher-type, cipher-key-len, auth-type, auth-key-len, auth-tag-len, key)

Initialize SRTP in the incoming direction

Callable from:

• XFL
• Python

Arguments

cypher_type values

auth_type values

Return Value

• None

Python Example:

sk.srtp_rx_init_srtp(rtpSessionId, 1, 30, 3, 20, 10, secret)

rtp_terminate_session

rtp_terminate_session (session-id)

Terminates an RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example:

rtp_terminate_session rtpSessionId

rtp_tx_set_dscp

rtp_tx_set_dscp (session-id, dscp)

Sets DSCP field in outgoing IP frames

Callable from:

• XFL
• Python

Arguments

dscp values

Return Value

• None

rtp_tx_setup_iuup

rtp_tx_setup_iuup (session-id [, IuUP-mode-version ], RFCI [, CRC])

Configures IuUP parameters for a transmitting session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_tx_tone

rtp_tx_tone (session-id, encoding, freq, power [, pt ] [, frames-per-packet])

Commences transmission of a tone consisting of one harmonic as an RTP stream

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

sk.rtp_tx_tone(rtpSessionId, 1, 440)

rtp_tx_dtmf

rtp_tx_dtmf (session-id, encoding, digits [, power] [, pt] [, frames-per-packet] [, digit-duration] [, repeats] [, blocking])

Sends DTMF digits over a given RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_tx_silence

rtp_tx_silence (session-id, encoding [, pt ] [, frames-per-packet])

Sends silence over a given session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_tx_wav

rtp_tx_wav (session-id, encoding, file-path [, repeats] [, pt] [, frames-per-packet])

Commences transmission of a waveform from a .wav file as an RTP stream

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

sk.rtp_tx_wav(rtpSessionId, 1, "Examples\\Voice\\digits.wav", 1)

rtp_tx_encoded

rtp_tx_encoded (session-id, encoding, file-path [, repeats] [, pt] [, frames-per-packet])

Commences transmission of a preencoded file as an RTP stream

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

originalWavPath = sk.getrootdir() + "\\Examples\\Voice\\female.wav"
encodedWavPath  = sk.getdir() + "\\voice-preencoded-rtp.wav"
recordedWavPath = sk.getdir() + "\\recorded-voice-rtp.wav"

sk.rtp_preencode(originalWavPath, encodedWavPath, 2)

rtpSessionID1 = sk.rtp_create_session("127.0.0.1", 2000, "127.0.0.1", 3000)
rtpSessionID2 = sk.rtp_create_session("127.0.0.1", 3000, "127.0.0.1", 2000)

sk.rtp_rx_wav(rtpSessionID1, recordedWavPath) # start saving incoming RTP stream to the .wav file
sk.rtp_tx_encoded(rtpSessionID2, 2, encodedWavPath, 1) # start sending encoded file

sk.sleep(5000)

sk.rtp_tx_off(rtpSessionID2)
sk.rtp_rx_off(rtpSessionID1)

rtp_tx_audio

rtp_tx_audio (session-id, encoding [, pt] [, frames-per-packet])

Commences transmission of the PC’s audio input (e.g., microphone)

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_tx_get_status

rtp_tx_get_status (session-id)

Retrieves RTP generation process status

Callable from:

• XFL
• Python

Arguments

Return Value

Return Type

• Integer

rtp_rx_setup_payload

rtp_rx_setup_payload (session-id, pt, mime [, mode])

Configures encoding to be used to handle incoming RTP packets with the specified dynamic payload type. See RFC 3550, 3551 on payload types.

Callable from:

• XFL
• Python

Arguments

mime values

mode values

Return Value

• None

rtp_rx_wav

rtp_rx_wav (session-id, file-path [, sampling-frequency])

Commences reception of the waveform from an RTP stream and recording it to a .wav file

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

originalWavPath = sk.getrootdir() + "\\Examples\\Voice\\female.wav"
encodedWavPath  = sk.getdir() + "\\voice-preencoded-rtp.wav"
recordedWavPath = sk.getdir() + "\\recorded-voice-rtp.wav"

sk.rtp_preencode(originalWavPath, encodedWavPath, 2)

rtpSessionID1 = sk.rtp_create_session("127.0.0.1", 2000, "127.0.0.1", 3000)
rtpSessionID2 = sk.rtp_create_session("127.0.0.1", 3000, "127.0.0.1", 2000)

sk.rtp_rx_wav(rtpSessionID1, recordedWavPath) # start saving incoming RTP stream to the .wav file
sk.rtp_tx_encoded(rtpSessionID2, 2, encodedWavPath, 1) # start sending
encoded file

sk.sleep(5000)

sk.rtp_tx_off(rtpSessionID2)
sk.rtp_rx_off(rtpSessionID1)

rtp_rx_audio

rtp_rx_audio (session-id)

Commences reception of the waveform and redirecting it to PC’s audio output

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_rx_detect_dtmf

rtp_rx_detect_dtmf (session-id)

Starts DTMF detection on a given RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_rx_dtmf

rtp_rx_dtmf (session-id)

Receives DTMF digits from given RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• DTMF digits. Valid characters are ‘0’..’9’, ‘*’ and ‘#’

Return Type

• Text String

rtp_rx_detect_tone

rtp_rx_detect_tone (session-id, freq [, power])

Starts tone detection on a given RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_rx_tone

rtp_rx_tone (session-id, freq)

Checks whether a tone was detected on an RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• True if the tone was detected, False otherwise.

Return Type

• Boolean

rtp_rx_off

rtp_rx_off (session-id)

Ceases reception on a given rtp session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

originalWavPath = sk.getrootdir() + "\\Examples\\Voice\\female.wav"
encodedWavPath  = sk.getdir() + "\\voice-preencoded-rtp.wav"
recordedWavPath = sk.getdir() + "\\recorded-voice-rtp.wav"

sk.rtp_preencode(originalWavPath, encodedWavPath, 2)

rtpSessionID1 = sk.rtp_create_session("127.0.0.1", 2000, "127.0.0.1", 3000)
rtpSessionID2 = sk.rtp_create_session("127.0.0.1", 3000, "127.0.0.1", 2000)

sk.rtp_rx_wav(rtpSessionID1, recordedWavPath) # start saving incoming RTP
stream to the .wav file
sk.rtp_tx_encoded(rtpSessionID2, 2, encodedWavPath, 1) # start sending encoded file

sk.sleep(5000)

sk.rtp_tx_off(rtpSessionID2)
sk.rtp_rx_off(rtpSessionID1)

rtp_rx_get_jitter

rtp_rx_get_jitter (session-id)

Retrieves the current jitter

Callable from:

• XFL
• Python

Arguments

Return Value

• Jitter in microseconds

Return Type

• Integer

rtp_rx_get_loss

rtp_rx_get_loss (session-id)

Retrieves the current jitter

Callable from:

• XFL
• Python

Arguments

Return Value

• Packet loss in %.

Return Type

• Integer

rtp_rx_get_comulative_loss

rtp_rx_get_comulative_loss (session-id)

Retrieves the cumulative packet loss ratio

Callable from:

• XFL
• Python

Arguments

Return Value

• Packet loss in %

Return Value

• Integer

rtp_tx_data

rtp_tx_data (session-id, pt, data)

Transmits data block within RTP session, e.g. for DTMF or tone events

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_tx_off

rtp_tx_off (session-id)

Ceases transmission on a given RTP session

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

originalWavPath = sk.getrootdir() + "\\Examples\\Voice\\female.wav"
encodedWavPath  = sk.getdir() + "\\voice-preencoded-rtp.wav"
recordedWavPath = sk.getdir() + "\\recorded-voice-rtp.wav"

sk.rtp_preencode(originalWavPath, encodedWavPath, 2)

rtpSessionID1 = sk.rtp_create_session("127.0.0.1", 2000, "127.0.0.1", 3000)
rtpSessionID2 = sk.rtp_create_session("127.0.0.1", 3000, "127.0.0.1", 2000)

sk.rtp_rx_wav(rtpSessionID1, recordedWavPath) # start saving incoming RTP stream to the .wav file
sk.rtp_tx_encoded(rtpSessionID2, 2, encodedWavPath, 1) # start sending encoded file

sk.sleep(5000)

sk.rtp_tx_off(rtpSessionID2)
sk.rtp_rx_off(rtpSessionID1)

rtp_set_mirroring_mode

rtp_set_mirroring_mode (session-id, mirroring-mode)

Controls RTP session mirroring mode

Callable from:

• XFL
• Python

Arguments

Return Value

• None

rtp_preencode

rtp_preencode (src-file-path, dst-file-path, encoding [, frames-per-packet])

Encodes .wav with the specified audio codec and saves the result to the other file.

Callable from:

• XFL
• Python

Arguments

Return Value

• None

Python Example

originalWavPath = sk.getrootdir() + "\\Examples\\Voice\\female.wav"
encodedWavPath  = sk.getdir() + "\\voice-preencoded-rtp.wav"
recordedWavPath = sk.getdir() + "\\recorded-voice-rtp.wav"

sk.rtp_preencode(originalWavPath, encodedWavPath, 2)

rtpSessionID1 = sk.rtp_create_session("127.0.0.1", 2000, "127.0.0.1", 3000)
rtpSessionID2 = sk.rtp_create_session("127.0.0.1", 3000, "127.0.0.1", 2000)

sk.rtp_rx_wav(rtpSessionID1, recordedWavPath) # start saving incoming RTP stream to the .wav file
sk.rtp_tx_encoded(rtpSessionID2, 2, encodedWavPath, 1) # start sending encoded file

sk.sleep(5000)

sk.rtp_tx_off(rtpSessionID2)
sk.rtp_rx_off(rtpSessionID1)

mos_calc

mos_calc (rxWav, txWav)

Calculates MOS

Callable from:

• XFL
• Python

Arguments

Return Value

1 - sucess, 0 - failure.

Return Type

• Integer

Python Example

txWav = "examples\\Audio\\Voice\\male.wav" # original
rxWav = sk.getdir() + "\\rec\\male-rx.wav" # degradated

if sk.mos_calc(rxWav, txWav):
  sk.print_("mos_val=", sk.mos_get_val_int, ", mos_delay=", sk.mos_get_delay, " sec")

mos_get_val_int

mos_get_val_int ()

Retrieves the calculated MOS value

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• Calculted MOS multiplied by 100. Range from 0 to 450

Return Type

• Integer

Python Example

txWav = "examples\\Audio\\Voice\\male.wav" # original
rxWav = sk.getdir() + "\\rec\\male-rx.wav" # degradated

 if sk.mos_calc(rxWav, txWav):
   sk.print_("mos_val=", sk.mos_get_val_int, ", mos_delay=", sk.mos_get_delay_ms, " ms")

mos_get_delay_ms

mos_get_delay_ms ()

Retrieves the calculated MOS value

Callable from:

• XFL
• Python

Arguments

• None

Return Value

• Delay calculated by MOS calculation process, in milliseconds.

Return Type

• Integer

Python Example

txWav = "examples\\Audio\\Voice\\male.wav" # original
rxWav = sk.getdir() + "\\rec\\male-rx.wav" # degradated

 if sk.mos_calc(rxWav, txWav):
   sk.print_("mos_val=", sk.mos_get_val_int, ", mos_delay=", sk.mos_get_delay_ms, " ms")

definevariable

definevariable (id, type [, defVal] [, flags] [, description])

Define a variable

Callable from:

• XFL
• Python

Arguments

flags values

If omitted the value is 2.

Return Value

• True if variable was successfully defined, False otherwise.

Return Type

Boolen

MD4

MD4 (data)

Calculates MD4 of an octet string

Callable from:

• XFL
• Python

Arguments

Return Value

• MD4 value

Return Type

• 16-octet Octet String.

Python Example

data = "Data"
MD4hash = sk.MD4(str2hex(data))

MD5

MD5 (data)

Calculates MD5 of an octet string

Callable from:

• XFL
• Python

Arguments

Return Value

• MD5 value

Return Type

• 16-octet Octet String

Python Example

data = "Data"
MD5hash = sk.MD5(str2hex(data))

DES_Encrypt

DES_Encrypt (key, data)

Encrypts data using DES

Callable from:

• XFL
• Python

Arguments

Return Value

• 8-Octet String

Return Type

• Octet String

Python Example

raw_data = "94 74 B8 E8 C7 3B CA 7D"
key = "A1 B2 C3 D4 E5 F6 57"
encrypted_data = sk.DES_Encrypt(key, data)

DES_Decrypt

DES_Decrypt (key, data)

Decrypt data using DES

Callable from:

• XFL
• Python

Arguments

Return Value

• 8-Octet String

Return Type

• Octet String

Python Example

key = "A1 B2 C3 D4 E5 F6 57"
raw_data = sk.DES_Decrypt(key, encrypted_data)

MD5DigestResponse

MD5DigestResponse (alg, nonce, nc, cnonce, user, password, realm, qop, method, uri)

Calculates MD5 Digest Response when SIP called party requires authentication

Callable from:

• XFL
• Python

Arguments

Return Value

• MD5 Digest Response

Return Type

• Text String

Python Example

nonce="46f9646f0794e0796d3874ff1a38c497f5200785"
SIPUserName="12345"
SIPUserPassword="54321"
realm="sip.example.com"
method="REGISTER"
uri="sip:sip.example.com"
md5response = sk.MD5DigestResponse("MD5", nonce, "", "", SIPUserName, SIPUserPassword, realm, "", method, uri)

ModPow

ModPow (base, exp, mod)

Computes (base ^ exp) % mod

Callable from:

• XFL
• Python

Arguments

Return Value

• A big integer, most significant octer first

Return Type

• Octet String

Python Example

g = "02" # MSB first
x = "09 a3 78 f9 b2 e3 32 a7 09 a3 78 f9 b2 e3 32 57" # MSB first
p = "21 68 C2" # MSB first
# e = g^x mod p:
e = sk.ModPow(g, x, p)

SHA1

SHA1 (data)

Calculates SHA1 of data

Callable from:

• XFL
• Python

Arguments

Return Value

• 20-octet SHA1 hash

Return Type

• Octet String

Python Example

sha1Param = "A1 B2 C3 D4 E5 F6 57 A1 B2 C3 D4 E5 F6 57 A1 B2 C3 D4 E5 F6"
H = sk.SHA1(sha1Param)

HMAC

HMAC (algorithm, key, data)

Calculates a hash-based message authentication code (HMAC)

Callable from:

• XFL
• Python

Arguments

algorithm values

Return Value

• HMAC

Return Type

• Octet String

MILENAGE_f1

MILENAGE_f1 (k, rand, sqn, amf, op)

Calculates f1 function from the MILENAGE algorithm set (3GPP TS 35.205-208)

Callable from:

• XFL
• Python

Arguments

Return Value

• MAC-A, a 8-octet (64-bit) network authentication code

Return Type

• Octet String

MILENAGE_f2345

MILENAGE_f2345 (k, rand, op)

Calculates f2345 function from the MILENAGE algorithm set (3GPP TS 35.205-208)

Callable from:

• XFL
• Python

Arguments

Return Value

• RES (Signed Response, 8 octets), CK (Confidentiality Key, 16 octets), IK (Integrity Key, 16 octets), AK (Anonymity Key, 6 octets)

Return Type

• Array of four Octet String

Python Example

k    = "01 25 45 74 58 35 43 65 14 21 33 12 54 77 92 ff"
rand = "a1 b2 c3 57 89 78 85 32 14 56 85 56 62 14 47 32"
res_ck_ik_ak = sk.MILENAGE_f2345(k, rand, "63 54 56 54 56 43 65 46 35 45 64 56 45 64 56 55")
res = res_ck_ik_ak(0)
ck  = res_ck_ik_ak(1)
ik  = res_ck_ik_ak(2)
ak  = res_ck_ik_ak(3)

MILENAGE_f1star

MILENAGE_f1star (k, rand, sqn, amf, op)

Calculates f1* function from the MILENAGE algorithm set (3GPP TS 35.205-208)

Callable from:

• XFL
• Python

Arguments

Return Value

• MAC-A, a 8-octet (64-bit) network authentication code

Return Type

• Octet String

MILENAGE_f5star

MILENAGE_f5star (k, rand, op)

Calculates f5* function from the MILENAGE algorithm set (3GPP TS 35.205-208)

Callable from:

• XFL
• Python

Arguments

Return Value

• AK, a 6-octet (48-bit) anonymity key

Return Type

• Octet String

TLS_AddTrustFile

TLS_AddTrustFile (src-file-path)

Adds the trusted CAs in order to verify client or server certificates

Callable from:

• XFL
• Python

Arguments

Return Value

• True if successful, False otherwise

Return Type

• Boolean

TLS_SetupCredentials

TLS_SetupCredentials (cert-file-path, key-file-path)

Sets a certificate/private key pair

Callable from:

• XFL
• Python

Arguments

Return Value

• True if successful, False otherwise

Return Type

• Boolean

Python API

send

send (pdu [, pdu [, …]])

Send a packet. The arguments are comma separated PDU data structures. The first one is a PDU of the top stack layer, the next one of the layer immedialtely below, etc. Each consecutive PDU is encoded and placed into a payload field of the follow-up PDU. The last argument is either an IP layer PDU or a data harness structure for passing the scripted part of the packet to an independently running transport stack (TCP for example) for further processing.

Callable from: from

• Python

Arguments

Return Value

• None

Example:

sk.send(pdu_ISUP, pdu_MTP2, pdu_MTP2_HAL)

receive

receive ([var-pdu] [, timeout], pdu-type1 [, pdu-type2 [, …]] [, var-extra-pdu1, extra-pco1 [, var-extra-pdu2, extra-pco2 [, …]]])

Receives a packet. Checks every incoming packet for any of the specified PDU types listed (pdu-type1, pdu-type2, …), left to right. For the first PDU type match, stores the corresponding packet data to a variable specified in “var-pdu” argument. If more than one of the listed PDU types is present in the packet, the leftmost one takes priority. If no match is found, the packet is ignored.

To intercept lower layers of the captured packet, one or more pairs of “var-extra-pdu, extra-pco” arguments may be specified. If a PDU of “extra-pco” layer is present in the packet, the PDU data is stored to “var-extra-pdu”. There is no exact PDU type check for “extra-pdu”.

Callable from:

• Python

Arguments

Return Value

• True in case of success, False otherwise

Return Type

• Boolean

Example:

var_SDPorINVITE = sk.create()  # var_PDU
var_SIP = sk.create()          # extra PDU var, here SIP will go, if present in the packet at all
var_TCPIP = sk.create()        # extra_PDU var, here TCP/IP Control will go

success = sk.receive (
  var_SDPorINVITE,             # will capture SDP or SIP.INVITE PDU data present in the incoming packet, can't predict which
  10000,                       # optional timeout
  sk.SDP,                      # expected PDU type to fill inSDPorINVITE variable
  sk.SIP.INVITE,               # another expected PDU type to fill inSDPorINVITE variable
  var_SIP,                     # optional var to capture SIP, if present in the packet received
  sk.SIP,                      # PDU type to fill var_SIP variable above
  var_TCPIP,                   # optional var to capture TCP/IP Control, if any
  sk.TCP_IP_Control)           # PDU type to fill var_TCPIP variable above

sleep

sleep (timeout)

Delays script execution

Callable from:

• Python

Arguments

Return Value

• None

Example:

sk.sleep(3000)

gettime

gettime ()

Time in milliseconds elapsed from the script start

Callable from:

• Python

Arguments

• None

Return Value

• Time in milliseconds elapsed from the script start

Return Type

• Integer

Example:

tStart = sk.gettime()
# do something
sk.print ("Duration: " + str(sk.gettime() - tStart) + " ms.")

run

run (path, [mode] [, arg1 [, arg2 [, …]]])

Start a child script

Callable from:

• Python

Arguments

arg values

Return Value

• A child script return value via stop() call; empty value if the child didn’t return anything.

Return Type

• Integer

Example:

ch = [None] * 3                   # array to store children ids
for i in range(3):
  ch[i] = sk.run("child.ats", 1)  # run another child asynchronously and store its id

waitchild

waitchild (child [, timeout] [, mode])

Waits for child script to complete. The child script must be previously run() in asynchronous mode.

Callable from:

• Python

Arguments

Return Value

• If the child script returned a value via stop(), then that value; empty value if the child didn’t return anything; -1 if timeout occurs and the child is still running.

Return Type

• Integer

Example

child = sk.run("Demo", 1, "child")  # '1' => asynch. mode
result = sk.waitchild(child)        # wait until the child completes

decode

decode (data, raw, type [, method])

Stops script execution

Callable from:

• Python

Arguments

Return Value

• True if data was successfully decoded, False otherwise.

Return Type

• Boolean

Example:

inSIP = sk.create(sk.SIP.REGISTER)
ok = sk.decode(inSIP, inUDP.Data, sk.SIP.REGISTER)

decodeex

decodeex (data, lowerPCO, upperPCO, mode [, pco1 [, pco2 [, …]]])

Decodes multiple PDUs from a string of octets or bits or from a lower PDU.

Callable from:

• Python

Arguments

mode values

Return Value

• A multilayer packet

Return Type

• Common.PDU Tree

Example:

# Decoding multiple layers from raw binary, which must result in 4 decoded PDUs (layers)
tree = sk.decodeex(binaryData, sk.Ethernet_L2, sk.IPv4, 1, sk.UDP)

create

create (type)

Creates a variable of a given type, typically a packet

Callable from:

• Python

Arguments

Return Value

• A reference to the created variable

Return Type

• PDU/field

gettype

gettype (data)

Returns type of a PDU or another data element

Callable from:

• Python

Arguments

Return Value

• Type of data

Return Type

• PDU type

getpco

getpco (data)

Determines PCO of the data type. Yields run-time error if the type is not a packet at any PCO.

Callable from:

• Python

Arguments

Return Value

• PCO of the data type

Return Type

• PCO

copy

copy (dst, src)

Creates a copy of a PDU (or any data element - e.g., PDU’s field).

Callable from:

• Python

Arguments

Return Value

• A PDU

Return Type

• PDU

equal

equal (data1, data2)

Compares data elements - PDUs or their fields. Data elements can be of any complexity. They must be of the same type or, at least, compatible types - e.g., both integers - otherwise run-time error occurs. If you want to compare safely being not sure about type compatibility, first compare types of the data using gettype().

Callable from:

• Python

Arguments

Return Value

• True if data elements are equal, False otherwise.

Return Type

• Boolean

spoil

spoil (data)

Overwrites the data element passed as the argument with a value of ASN.1 ‘ANY’ type. You can then modify that ‘ANY’ and thus substitute any possible encoding for the ‘spoiled’ element. This is useful in negative testing, when invalid from the point of view of the protocol specification packet has to be sent.

Callable from:

• Python

Arguments

Return Value

• None

random

random ()

Pseudo-random number in range 0..1. Independent from language-specific random generation. Pseudo-random sequence can be restarted by seedrandom.

Callable from:

• Python

Arguments

• None

Return Value

• None

print

print (value1 [, value2 [, …]])

Outputs one or more values to the Output pane

Callable from:

• Python

Arguments

Return Value

• None

sprint

sprint (value1 [, value2 [, …]])

Formats one or more values as a string, identically to print().

Callable from:

• Python

Arguments

Return Value

• A string with formatted data

Return Type

• String

keypressed

keypressed ()

Checks for keyboard input.

Callable from:

• Python

Arguments

• None

Return Value

• True if a key has been pressed.

Return Type

• Boolean

getchar

getchar ()

Gets a character from the keyboard.

Callable from:

• Python

Arguments

• None

Return Value

• A string containing a character from the keyboard. Empty string if no key has been pressed.

Return Type

• String

getchars

getchars ()

Gets all available character from the keyboard.

Callable from:

• Python

Arguments

• None

Return Value

• A string containing the characters from the keyboard. Empty string if no key has been pressed.

Return Type

• String

bindevent

bindevent (functionName)

Creates a handler for the event from a HTML control. Assign it to a HTML event handler.

Callable from:

• Python

Arguments

Return Value

• A wrapper COM object to be used as an event handler.

Example:

ie.Document.getElementById("MyButton").onclick = sk.bindevent("OnMyButtonClick")

createwindow

createwindow (utl, options [, arguments])

Waits for child script to complete. The child script must be previously run() in asynchronous mode.

Callable from:

• Python

Arguments

Return Value

• A reference to a created window object that represents an open window in the browser.

helper

helper (class)

Creates a Packet Studio-defined helper object.

Callable from:

• Python

Arguments

Return Value

• A reference to the created object.

getcorecount

getcorecount ()

Get number of CPU cores available.

Callable from:

• Python

Arguments

• None

Return Value

• Number of cores.

Return Value

• Integer

mos_get_val

mos_get_val ()

Returns the calculated MOS value.

Callable from:

• Python

Arguments

• None

Return Value

• MOS value calculated, range from 0 to 4.5

Return Value

• Float

Example:

txWav = "examples\\Audio\\Voice\\male.wav" # original
rxWav = sk.getdir() + "\\rec\\male-rx.wav" # degradated

if sk.mos_calc(rxWav, txWav):
  sk.print_("mos_val=", sk.mos_get_val, ", mos_delay=", sk.mos_get_delay, " sec")

mos_get_delay

mos_get_delay ()

Returns the calculated MOS delay.

Callable from:

• Python

Arguments

• None

Return Value

• Delay value calculated, in fractional seconds

Return Value

• Float

Python Example:

txWav = "examples\\Audio\\Voice\\male.wav" # original
rxWav = sk.getdir() + "\\rec\\male-rx.wav" # degradated

if sk.mos_calc(rxWav, txWav):
  sk.print_("mos_val=", sk.mos_get_val, ", mos_delay=", sk.mos_get_delay, " sec")

presskey

presskey (char)

Simulates a key pressed.

Callable from:

• Python

Arguments

Return Value

• None

Python Example:

sk.presskey(ch);