VSI Runtime

• vsi::runtime::Runtime
  • Function Reference
• vsi::runtime::Custom
  • Utility Class: vsi::runtime::CustomCB
  • Function Reference
  • Footnotes
• vsi::runtime::Inout
  • Function Reference
  • Footnotes
• vsi::runtime::TcpServer
  • Function Reference
  • Protected Members
• vsi::runtime::TcpClient
  • Function Reference
  • Protected Members
• vsi::runtime::Net
  • Function Reference
• vsi::runtime::Interconnect
  • Function Reference
• vsi::runtime::Connect
  • Function Reference
• vsi::runtime::Log
  • Function Reference
  • Footnotes
• Buffer
  • Function Reference
    • Command to construct an empty buffer
      • Usage in C/C++
      • Usage in Python
    • Command to construct a buffer of specific size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to construct a buffer using a null terminated string
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to construct a buffer using a data pointer and given length
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to copy a single byte into the buffer at the given offset
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to copy another Buffer’s contents into this buffer at the given offset
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return an integer value and forwards the current offset by it’s size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to compare the content of this buffer with another Buffer
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to store an integer at the current offset and forwards the offset by integer’s size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to fill the buffer with the given pattern
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return a short value at current offset and forward the offset by short size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to write the short value at current offset and forward the offset by short size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to read a char value at current offset and forward the offset by char size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to write the char value at current offset and forward the offset by char size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return the size of the buffer minus current offset
      • Usage in C/C++
      • Usage in Python
    • Command to return the underlying raw pointer of stored data at current offset
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to rewind the buffer, setting the offset at zero
      • Usage in C/C++
      • Usage in Python
    • Command to return the underlying raw pointer of stored data at current offset
      • Usage in C/C++
      • Usage in Python
    • Command to return the total size of the underlying buffer
      • Usage in C/C++
      • Usage in Python
    • Command to return the raw pointer of the underlying buffer
      • Usage in C/C++
      • Usage in Python
    • Command to return a part of buffer clipped to the specified size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return a string formatted as hexadecimal and separated by the provided separator character.
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return the current offset of the buffer.
      • Usage in C/C++
      • Usage in Python
    • Command to set the buffer contents. The underlying buffer will resize to accommodate the new size.
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to set the buffer contents to a null terminated string. The underlying buffer will resize to accommodate the new size.
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to change the buffer to use the provided raw buffer as the underlying buffer
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to append data to the current buffer
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to append another Buffer’s contents to the current buffer
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to set the current offset to provided value
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to specify the target offset
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return the memory offset where the buffer should be written to.
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to truncate the buffer by provided size
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to allocate the given size for the underlying buffer
      • Parameters
      • Usage in C/C++
      • Usage in Python
• hls::stream and hls::stream_buffer
  • Function Reference
    • Command to construct a stream_buffer
    • Command to read specified number of bytes from the stream_buffer
      • Parameters
    • Command to return the size of all the data available in the stream pipeline
      • Parameters
    • Command to pop off the first chunk of data from the stream and return it
      • Parameters
• vsi::device
  • Function Reference
    • Command to Write number of bytes to the device
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to read specified number of bytes from the vsi::device
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to write specified number of bytes
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to read specified number of bytes
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command that blocks until an interrupt or till timeout expires
      • Parameters
      • Usage in C/C++
      • Usage in Python
    • Command to return the underlying operating system device descriptor
      • Usage in C/C++
      • Usage in Python
    • Language Specific notes and code snippets