LogoLogo
What's NewDeveloper CommunitySupportStatus
  • 🚀Get Started
    • What is JourneyApps Platform?
    • Tutorial: Build your First App
      • 1. Introduction
      • 2. Create a new App
      • 3. OXIDE IDE Overview
      • 4. Hello World app
      • 5. The Data Model
      • 6. View Components
      • 7. Queries and Data Sync
      • 8. Simple Navigation
      • 9. View Stack
      • 10. Input Validation
      • 11. View Parameters
      • 12. Data Manipulation
      • 13. Responsive Apps
      • 14. Styling
      • 15. Lists
      • 16. GPS Capturing
      • 17. Relationships
      • 18. Multiple User Roles
      • 19. Deployment and Users
      • 20. Version Control
      • 21. CSV and APIs
      • 22. Conclusion
    • JourneyApps Platform Fundamentals
      • Creating a New App
        • Git-enabled Apps
      • What are Views?
      • What is the Data Model?
      • JourneyApps Syntax Basics
      • Access the Database (DB)
        • Manipulate DB Objects
        • Query DB Objects
      • View Navigation
        • Deep Linking
      • CloudCode Overview
      • OXIDE (Online IDE)
  • 💻Build your App
    • JourneyApps Syntax
      • Syntax Basics
      • Access the DB
      • View Navigation
      • Async & Await
      • TypeScript Apps (Beta)
        • runtime-build package
        • TypeScript App Troubleshooting
      • What's New in V4
        • Updating to the V4 API
    • Configure your Data Model
      • What is the data model?
      • Reference: model
        • field
        • belongs-to
        • has-many
        • index
      • Data Rules
        • Data Buckets
        • Sync Rules - Limit data synced to devices
        • Data ACLs - Limit access to data
        • Real-world example for Data Rules
        • ❔FAQs
        • Migrate to Data Rules
      • App Indexes
      • Webhooks
    • UI Components
      • All UI Components
        • actionSheet
        • Attachments
        • button
        • button-group
        • capture-coordinates
          • marker
          • marker-query
        • capture-file
        • capture-photo
        • capture-signature
        • card
          • accent
          • action
        • columns
          • column
        • component
        • context-menu
          • divider
          • item
        • CSV
        • date-input
        • datetime-input
        • dialog
          • body
        • display-3d-model
          • 📖display-3d-model Guides
            • Guide 1: Initialize and layout a 3D model in a view
            • Guide 2: Control playback position
            • Guide 3: Troubleshooting controls
        • display-coordinates
        • display-file
        • display-image
        • display-photo
        • display-signature
        • heading
        • html
          • HTML Advanced Topics
          • ❔HTML FAQs
          • 📖Guide: HTML & JourneyApps iFrame Client
        • icons
        • info
        • info-table
          • row
        • journey.photos (capture multiple photos)
        • JourneyPrinter (print PDFs)
        • grid
          • cell
          • 📖grid Examples
        • list
          • list-item
            • accent
            • asset
            • pills
              • pill
            • action
        • multiple-choice-checklist
        • navigation (Navigation drawer)
          • general-section
            • item
          • section
            • item
              • item
          • ❔navigation FAQs
        • notification
        • object-dropdown
        • object-list
          • action
        • object-repeat
        • object-table
          • action
          • column
            • action
            • edit-boolean
            • edit-date
            • edit-datetime
            • edit-integer
            • edit-number
            • edit-select
            • edit-text
            • edit-time
            • edit-typeahead
              • action
            • header-action
          • column-group
          • empty-action
          • 📖object-table Guides
            • Actions
            • Cell callouts
            • Column groups
            • Columns
            • Controlled object-table
            • Controls
            • Copy & paste data
            • Edit cells
            • Filters
            • Frozen columns
            • Fullscreen object-table
            • Mode
            • State
            • Styles
        • optionList
        • PhotonSync (transfer data offline)
        • power-bi
          • 📖Guide: PowerBI Embedding
        • scan-barcode
        • shortcut
        • sidebar
        • single-choice-dropdown
        • single-choice-radio
        • template
        • text-input
        • time-input
        • toggle
        • view
      • JS/TS Events
      • Show / Hide UI Components
      • View Templates
      • XML Fields (Attributes)
        • align-content
        • align-controls
        • align-label
        • bind
        • clear-button-visibility
        • control-order
        • disabled
        • error-message
        • icon-position
        • id
        • hide-if
        • modifier-text
        • label
        • label-case
        • label-color
        • on-change
        • on-press
        • placeholder
        • required
        • show-if
    • JS / TS APIs
      • Attachment
      • Bluetooth (Beta)
      • Broadcast
      • component
      • CSV
      • DB
      • HardwareBarcode
      • journey
        • journey.config
        • journey.container
        • journey.device
        • journey.diagnostics
        • journey.dialog
        • journey.files
        • journey.hardware
        • journey.photos
        • journey.runtime
        • journey.sensors
        • journey.viewStack
      • JourneyPrinter
      • KeyboardBarcode
      • LocalDB
      • NFC
      • OnlineDB
      • PhotonSync
      • SerialPort
      • ShortcutManager
      • TCPSocket
      • user
    • Extend your App with Custom Code
      • App packages
        • App packages overview
        • PDF report package
        • TypeScript library & unit tests
        • Manage External Dependencies
      • Custom HTML
    • Style & Customize your App
      • Style & configure UI components
        • Overview
        • Understand extendable themes
        • Use themes on a view
        • Theme specific components on a view
        • Examples
        • Debugging
        • ❔FAQs
      • Change your App Font
      • Custom Branding
        • Custom Container Features
        • Special Requirements for iOS Containers
    • Integrate your App
      • Backend integrations with CloudCode
      • Barcode Scanning
        • Barcode Scanning using Keyboard Emulation
        • Hardware Barcode Scanning
        • scan-barcode
      • Bluetooth Low Energy (BLE)
      • Broadcast API
      • HTTP requests (Fetch API)
      • JourneyApps Print (Android)
      • Maps and navigation
      • NFC
      • Opening external links/apps
      • Serial Port
      • TCP Sockets
    • Design Intuitive Apps
      • UX Guidelines
      • Write Effective Copy
  • 📱App Features
    • RealWear® Voice Control
      • Automatic Voice Commands
        • Automatic Voice Commands - Advanced
      • Manual Voice Commands
    • App, Runtime and Container Updates
    • Batch Operations (App)
    • Call JS/TS Functions from XML
    • Capture GPS Locations
    • Push Notifications
    • Translations
    • XML Format Strings
    • Webhooks (External)
  • 🌐CloudCode
    • CloudCode Overview
    • Trigger a CloudCode Task
      • Trigger CC with a Schedule
      • Trigger CC via a Webhook
      • Trigger CC from an App
      • Trigger CC from Another Task
      • Trigger CC via HTTP
    • Attachments in CloudCode
    • Timezones
    • Advanced CloudCode Topics
      • Access Multiple DBs in CloudCode Tasks
      • Batch API (CloudCode)
      • CloudCode Dependencies
      • Configure HTTPS in CloudCode
      • Deployment environment variables
      • Local CloudCode Development
      • PDF Reports using CloudCode
      • Shared CloudCode Tasks
      • Translations in CloudCode
  • 📥Backend API
    • Introduction
    • API Reference
      • Retrieve All Objects
      • Query Objects
      • Sort Results
      • Limit and Skip
      • Count Objects
      • Create a New Object
      • Retrieve a Single Object
      • Update a Single Object
      • Delete a Single Object
      • Batch Operations (v4 API)
      • Oplog API
      • Retrieve the App Data Model
      • Manage App Users and Sessions
      • Field Representation
      • Error Responses
    • API Limits
    • Update to the V4 API
  • ⚙️Technical
    • Data Synchronization Priority
    • Device Diagnostics
    • JSON1 Query Engine
    • Improve App Performance
    • Security Measures
    • Supported Platforms
      • Web Container
      • Windows Installer
    • Domain Whitelist
  • 🖥️OXIDE
    • Get started with OXIDE
      • OXIDE Overview
      • Components of OXIDE
    • Configure Testing Deployments
    • Edit and Manage Files
      • How to Navigate to a Function
      • Manage External Dependencies
    • Create and Manage App Containers
    • Debugging & Troubleshooting
      • Common Troubleshooting Pointers
      • App Diagnostics Reports
      • Build Logs
    • OXIDE Workspaces
      • OXIDE Trees
  • ❕Deprecated Features
    • Deprecated Features and Components
Powered by GitBook
On this page
  1. Build your App
  2. JS / TS APIs

TCPSocket

PreviousShortcutManagerNextuser

Last updated 2 years ago

Version and platform compatibility

  • This feature was introduced in version 21.1.1 of the JourneyApps Container for iOS, Android and Desktop, and requires version 4.78.0 or greater of the JourneyApps Runtime.

  • TCPSocket support is currently only available for customers on the plan.

The TCPSocket API allows applications to directly connect with external devices over TCP sockets.

Checking if TCPSocket is supported

A TCPSocket.info() function is available to check if the user's device has access to the TCP sockets. It returns an object:

Field
Type
Description

supported

boolean

Indicates if TCPSocket is supported on the current device. Not supported on Web

Connecting to a TCP socket

To connect to a TCP socket, the host and port of the socket is required.

To connect, use var tcpSocket = TCPSocket.connect({host: host, port: port, timeout: timeout}, readHandler, closeHandler).

Parameter
Description

host

String hostname of socket, e.g. '10.0.0.1'.

port

Number of the port of the socket, e.g. 8080.

timeout

Number value in milliseconds. This value overrides the timeout period, which closes the TCP socket connection after network inactivity. Its default value is 10 seconds.

Note: This parameter was introduced in version 4.86.6 of the JourneyApps Runtime.

readHandler

Optional callback that gets called when data is present on the socket.

closeHander

Optional callback that gets called when an error occurs or socket closes. The closeHandler will have an optional error parameter that will be a string, or null/undefined when there isn't an error.

var socketHost = '192.168.1.1';
var socketPort = 8080;

var readHandler = function(data) {
  // data received from TCP socket
  console.log(data);
}

var closeHandler = function(error) {
  if (error) {
    console.log("Error", error);
  }
}
// use a try .. catch, since an exception may be thrown.
try {
  var tcpSocket = TCPSocket.connect({host: socketHost, port: socketPort}, readHandler, closeHandler);
} catch (error) {
  console.log(error);
}
var socketHost = '192.168.1.1';
var socketPort = 8080;

var readHandler = function(data) {
  // data received from TCP socket
  console.log(data);
}

var closeHandler = function(error) {
  if (error) {
    console.log("Error", error);
  }
}
// use a try .. catch, since an exception may be thrown.
try {
  var tcpSocket = await TCPSocket.connect({host: socketHost, port: socketPort}, readHandler, closeHandler);
} catch (error) {
  console.log(error);
}

Reading data

There are two ways to read data from the socket.

The readHandler from the example above uses a callback with data in Uint8Array when there is data available.

A ReadableStream object is also available. To use the ReadableStream, the following can be used:

var stream = mySocket.stream;
var streamReader = stream.getReader();

function startRead() {
  setTimeout(function() {
    streamReader.read().then(function(dataRead) {
      if (dataRead.done) {
      console.log("Stream finished");
    } else {
      // use data:
      console.log("Data", dataRead.value);

      // trigger another read:
      startRead();
    }

    // in the case where view variables are changed,
    // e.g. updating text on the view,
    // we need to call the journey.forceDigest() function
    // due to this code running inside a setTimeout:
    }).then(journey.forceDigest);
  }, 1000);
}

// call the startRead function once:
startRead();
var stream = mySocket.stream;
var streamReader = stream.getReader();

function startRead() {
  setTimeout(async function() {
    var dataRead = await streamReader.read();

    if (dataRead.done) {
      console.log("Stream finished");
    } else {
      // use data:
      console.log("Data", dataRead.value);

      // in the case where view variables are changed,
      // e.g. updating text on the view,
      // we need to call the journey.forceDigest() function
      // due to this code running inside a setTimeout:
      journey.forceDigest();

      // trigger another read:
      startRead();
    }
  }, 1000);
}

// call the startRead function once:
startRead();

Data must be continually read when using the ReadableStream. In the example above, the data is read one second after previous reading.

ReadableStream methods can be used, including piping through other streams, e.g. TextDecoderStream:

var stream = mySocket.stream.pipeThrough(new TextDecoderStream());

stream.read().then(function(data) {
  if (!data.done) {
    // result is String
    console.log(data.value);
  }
});
var stream = mySocket.stream.pipeThrough(new TextDecoderStream());

var data = await stream.read();

if (!data.done) {
  // result is String
  console.log(data.value);
}

Writing to a socket

The TCPSocket.connect function returns a TCPSocket instance. This instance is used to write data to the socket in binary (Uint8Array) format.

var tcpSocket = TCPSocket.connect({host: socketHost, port: socketPort}, readHandler, closeHandler);

// writing binary data ("Hello" in hexadecimal)
var binaryData = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f]);
tcpSocket.write(binaryData);
var tcpSocket = await TCPSocket.connect({host: socketHost, port: socketPort}, readHandler, closeHandler);

// writing binary data ("Hello" in hexadecimal)
var binaryData = new Uint8Array([0x48, 0x65, 0x6c, 0x6c, 0x6f]);
await tcpSocket.write(binaryData);

Closing and resetting

To close a connection, call close() on the connection object, e.g. tcpSocket.close().

To reset all the sockets, call TCPSocket.reset(). This closes all open sockets.

There is also an isOpen property on each connection object, e.g. tcpSocket.isOpen that returns a boolean to check if the socket is open. Note that it may take some time after a socket has disconnected for the socket itself to register that it has closed.

💻
Enterprise