Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
cascading::Cascading_1_0_1 Interface Reference

Cascading Interface. More...

import"Cascading.idl";

Classes

struct  ProtocolMapping
 Mapping from appl protocol id to name and transport protocol. More...
 

Public Types

enum  Type { USB_MULTI_IP, USB_SINGLE_IP_NAT }
 Cascading type. More...
 

Public Member Functions

int setType (in Type type)
 Set the cascading type. More...
 
int getType (out Type type)
 Get the cascading type. More...
 
void getIndex (out int idx)
 Get the index of this unit in the cascade. More...
 
void getMasterIpAddress (out string masterIpAddress)
 Get the IPv4 address of the master. More...
 
void getMasterIpV6Address (out string masterIpV6Address)
 Get the IPv6 address of the master. More...
 
void getProtocolMappings (out vector< ProtocolMapping > mappings)
 Get the application protocol id -> name/transport-proto mappings. More...
 

Public Attributes

constant int ERR_NOT_AVAILABLE = 1
 Error codes.
 
constant int ERR_NOT_SUPPORTED_ON_SLAVE = 2
 

Detailed Description

Cascading Interface.

Member Enumeration Documentation

Cascading type.

Enumerator
USB_MULTI_IP 

USB chain; one IP per device; transparent.

USB_SINGLE_IP_NAT 

USB chain; single IP; NAT(port-forwarding)

Member Function Documentation

void cascading::Cascading_1_0_1::getIndex ( out int  idx)

Get the index of this unit in the cascade.

Index 0 means this is the master unit. A cascading master is a unit with an active ethernet uplink and no active uplink on the USB-B connector.

Parameters
idx- the index of this unit in the cascade
void cascading::Cascading_1_0_1::getMasterIpAddress ( out string  masterIpAddress)

Get the IPv4 address of the master.

If the address is not available an empty string is returned.

Parameters
masterIpAddress- the IPv4 address of the master
void cascading::Cascading_1_0_1::getMasterIpV6Address ( out string  masterIpV6Address)

Get the IPv6 address of the master.

If the address is not available an empty string is returned.

Parameters
masterIpV6Address- the IPv6 address of the master
void cascading::Cascading_1_0_1::getProtocolMappings ( out vector< ProtocolMapping mappings)

Get the application protocol id -> name/transport-proto mappings.

Parameters
mappings- the protocol id -> name/transport-proto mappings
int cascading::Cascading_1_0_1::getType ( out Type  type)

Get the cascading type.

A slave unit will return ERR_NOT_AVAILABLE when the master unit has not yet propagated the cascading type to the slaves. This behaviour is typically seen while the device is booting and network setup did not finish yet.

Parameters
type- the cascading type
Returns
0 on success
ERR_NOT_AVAILABLE if not yet known
int cascading::Cascading_1_0_1::setType ( in Type  type)

Set the cascading type.

This operation is only supported on the cascading master. On slave units it will return ERR_NOT_SUPPORTED_ON_SLAVE. A cascading master is a unit with an active ethernet uplink and no active uplink on the USB-B connector.

Parameters
type- the cascading type
Returns
0 on success
ERR_NOT_SUPPORTED_ON_SLAVE if this is a slave unit

The documentation for this interface was generated from the following file: