IBridgePortDevice Interface

This interface is implemented by a local bridge device.

Declaration

interface IBridgePortDevice extends ${IDevice} {
    // Properties
    ${bridgePort}: number;
    ${bridgeServer}: string;
    readonly ${isLocal}: boolean;
    readonly ${isListening}: boolean;
    ${remoteLogin}: string;
    ${remoteDomain}: string;
    ${remotePassword}: string;
    readonly ${securityDescriptor}: string;
    ${emulateBaudrate}: boolean;
    ${emulateTxOverflow}: boolean;
    ${crossoverProbability}: number;
    ${DTR}: ${DestinationPins};
    ${DSR}: ${DestinationPins};
    ${DCD}: ${DestinationPins};
    ${RTS}: ${DestinationPins};
    ${CTS}: ${DestinationPins};
    ${RI}: ${DestinationPins};

    // Methods
    ${restoreDefaultPins}(): void;
    ${startListening}(securityDescriptor?: string): void;
}

public interface IBridgePortDevice : ${IDevice}
{
    // Properties
    uint ${bridgePort} { get; set; }
    string ${bridgeServer} { get; set; }
    bool ${isLocal} { get; }
    bool ${isListening} { get; }
    string ${remoteLogin} { get; set; }
    string ${remoteDomain} { get; set; }
    string ${remotePassword} { get; set; }
    string ${securityDescriptor} { get; }
    bool ${emulateBaudrate} { get; set; }
    bool ${emulateTxOverflow} { get; set; }
    double ${crossoverProbability} { get; set; }
    ${DestinationPins} ${DTR} { get; set; }
    ${DestinationPins} ${DSR} { get; set; }
    ${DestinationPins} ${DCD} { get; set; }
    ${DestinationPins} ${RTS} { get; set; }
    ${DestinationPins} ${CTS} { get; set; }
    ${DestinationPins} ${RI} { get; set; }

    // Methods
    void ${restoreDefaultPins}();
    void ${startListening}(string securityDescriptor);
}

struct IBridgePortDevice : IDevice
{
    // Properties
    unsigned ${bridgePort};  // get set 
    _bstr_t ${bridgeServer};  // get set 
    VARIANT_BOOL ${isLocal};  // get 
    VARIANT_BOOL ${isListening};  // get 
    _bstr_t ${remoteLogin};  // get set 
    _bstr_t ${remoteDomain};  // get set 
    _bstr_t ${remotePassword};  // get set 
    _bstr_t ${securityDescriptor};  // get 
    VARIANT_BOOL ${emulateBaudrate};  // get set 
    VARIANT_BOOL ${emulateTxOverflow};  // get set 
    double ${crossoverProbability};  // get set 
    ${DestinationPins} ${DTR};  // get set 
    ${DestinationPins} ${DSR};  // get set 
    ${DestinationPins} ${DCD};  // get set 
    ${DestinationPins} ${RTS};  // get set 
    ${DestinationPins} ${CTS};  // get set 
    ${DestinationPins} ${RI};  // get set 

    // Methods
    HRESULT ${restoreDefaultPins}();
    HRESULT ${startListening}(_bstr_t securityDescriptor);
};

IBridgePortDevice Properties

bridgePort

bridgePort: number;

uint bridgePort { get; set; }

unsigned bridgePort;  // get set

Port number of other side of the local or remote bridge.

bridgeServer

bridgeServer: string;

string bridgeServer { get; set; }

_bstr_t bridgeServer;  // get set

Name or address of the remote server on which a listening port is created. Do not set this property to create a local bridge.

isLocal

readonly isLocal: boolean;

bool isLocal { get; }

VARIANT_BOOL isLocal;  // get

True if this device is part of a local bridge or false otherwise. If isListening property is true, this property would be false.

isListening

readonly isListening: boolean;

bool isListening { get; }

VARIANT_BOOL isListening;  // get

True if this device is in a listening state (that is, “server” side of a remote bridge).

remoteLogin

remoteLogin: string;

string remoteLogin { get; set; }

_bstr_t remoteLogin;  // get set

Optional user name or login to use when connecting to a remote listening port (do not set this property for local bridges).

remoteDomain

remoteDomain: string;

string remoteDomain { get; set; }

_bstr_t remoteDomain;  // get set

Optional domain name to use when connecting to a remote listening port (do not set this property for local bridges). Can be empty to use default remote computer domain.

remotePassword

remotePassword: string;

string remotePassword { get; set; }

_bstr_t remotePassword;  // get set

Optional user password to use when connecting to a remote listening port (do not set this property for local bridges).

This property is write-only.

securityDescriptor

readonly securityDescriptor: string;

string securityDescriptor { get; }

_bstr_t securityDescriptor;  // get

This read-only property returns a copy of listening's port security descriptor, in string SD format.

emulateBaudrate

emulateBaudrate: boolean;

bool emulateBaudrate { get; set; }

VARIANT_BOOL emulateBaudrate;  // get set

Turn emulation of baud rate on or off.

By default, Virtual Serial Port Tools does not emulate baud rate.

emulateTxOverflow

emulateTxOverflow: boolean;

bool emulateTxOverflow { get; set; }

VARIANT_BOOL emulateTxOverflow;  // get set

Turn emulation of output buffer overflow on or off.

By default, Virtual Serial Port Tools does not emulate output buffer overflow.

crossoverProbability

crossoverProbability: number;

double crossoverProbability { get; set; }

double crossoverProbability;  // get set

Single bit crossover probability. May be a floating-point number between 0 and 0.5 (inclusive). Value 0 disables line noise emulation.

By default, Virtual Serial Port Tools does not emulate line noise. Change the value of this property to enable line noise emulation.

DTR

DTR: ${DestinationPins};

${DestinationPins} DTR { get; set; }

${DestinationPins} DTR;  // get set

Allows configuration of custom pin-out for a local DTR line.

DSR

DSR: ${DestinationPins};

${DestinationPins} DSR { get; set; }

${DestinationPins} DSR;  // get set

Allows configuration of custom pin-out for a local DSR line.

DCD

DCD: ${DestinationPins};

${DestinationPins} DCD { get; set; }

${DestinationPins} DCD;  // get set

Allows configuration of custom pin-out for a local DCD line.

RTS

RTS: ${DestinationPins};

${DestinationPins} RTS { get; set; }

${DestinationPins} RTS;  // get set

Allows configuration of custom pin-out for a local RTS line.

CTS

CTS: ${DestinationPins};

${DestinationPins} CTS { get; set; }

${DestinationPins} CTS;  // get set

Allows configuration of custom pin-out for a local CTS line.

RI

RI: ${DestinationPins};

${DestinationPins} RI { get; set; }

${DestinationPins} RI;  // get set

Allows configuration of custom pin-out for a local RI line.

IBridgePortDevice Methods

restoreDefaultPins

restoreDefaultPins(): void;

void restoreDefaultPins();

HRESULT restoreDefaultPins();

This method restores default pin-out assignment.

startListening

startListening(securityDescriptor?: string): void;

void startListening(string securityDescriptor);

HRESULT startListening(_bstr_t securityDescriptor);

securityDescriptor: Optional listening port's security descriptor, in string SD format. If omitted, or empty string is passed, defaults to allowing “Everyone” to connect to the port.

Starts listening port, optionally applying passed security descriptor. After this method returns, a remote bridge device may connect to this listening port.

Note that the actual connection occurs only when the client bridge port is opened by some application.

IDevice DestinationPins