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

    Interface ServiceInfo

    Information used to connect to a DOIP service. This includes metadata about the service and information about the service's available network interfaces.

    Note that because ServiceInfo extends ServiceInfoInterface, network interface information can be defined at the top level of this object or in the interfaces property.

    // A native-DOIP-only service
    const tcpServiceInfo = {
        ipAddress: 'localhost',
        port: 9000
    };

    // An DOIP-API-for-HTTP-Clients-only service
    const httpsServiceInfo = {
       baseUri: 'https://localhost:8443/doip'
    };

    // A service with both TCP and HTTPS listeners
    const multiServiceInfo = {
        interfaces: [
            {
                protocol: 'TCP',
                ipAddress: 'localhost',
                port: 9000
            },
            {
                protocol: 'HTTPS',
                baseUri: 'https://localhost:8443'
            }
        ]
    };
    interface ServiceInfo {
        protocol?: "TCP" | "HTTPS";
        ipAddress?: string;
        port?: number;
        baseUri?: string;
        path?: string;
        serviceId?: string;
        protocolVersion?: string;
        publicKey?: JsonWebKey;
        interfaces?: ServiceInfoInterface[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    protocol? ipAddress? port? baseUri? path? serviceId? protocolVersion? publicKey? interfaces?

    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.

    serviceId?: string

    The identifier for the service, typically used as the target ID for service-level operations.

    protocolVersion?: string

    The DOIP protocol version supported by the service.

    publicKey?: JsonWebKey

    The public key of the service, used for verification.

    interfaces?: ServiceInfoInterface[]

    Interfaces through which the service can be accessed, in addition to any interface defined at the top level of the ServiceInfo object.

    Settings

    Member Visibility

    On This Page

    Properties