DOIP Client Library - JavaScript Version
    Preparing search index...

    Interface ServiceInfoInterface

    Describes the basic connection details needed to communicate with a DOIP service via a specific endpoint.

    interface ServiceInfoInterface {
        protocol?: "TCP" | "HTTPS";
        ipAddress?: string;
        port?: number;
        baseUri?: string;
        path?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    protocol? ipAddress? port? baseUri? path?

    Properties

    protocol?: "TCP" | "HTTPS"

    The protocol used for communication.

    ipAddress?: string

    The IP address or hostname of the service.

    "127.0.0.1"

    "example.org"
    port?: number

    The port number on which the service is listening.

    baseUri?: string

    The base URI for connections using the DOIP API for HTTP Clients. See also Cordra's documentation on this API.

    "https://example.org/doip/"
    path?: string

    Additional path information for the service endpoint. For HTTPS interfaces without a baseUri, the path will be used to construct a URI, along with the ipAddress and port.

    Settings

    Member Visibility

    On This Page

    Properties