IGreManager

​

Interface IGreManager

interface IGreManager

Extends com.amazon.apmf.IStandard GRE/GRE-TAP tunnel manager interface. Provides APIs to create, remove, and query GRE/GRE-TAP tunnel interfaces. Asynchronous operations deliver results via IGreEventListener.

​

Methods

​

createInterface()

void createInterface(u8 interfaceId, GreConfig* config)

Create a GRE/GRE-TAP tunnel interface. This is an asynchronous operation. On success, a state UP event is delivered. On failure, a create failure event is delivered.

​

Parameters

interfaceId

u8 — Required unique interface identifier for the GRE interface.

config

GreConfig* — Required the tunnel configuration. localIp and remoteIp are mandatory.

​

Throws

• SecurityError — if the app does not have the permission.
• NullPointerError — if config is null.
• InvalidArgumentError — if configuration is invalid.
• BaseError — on unexpected failure.

Requires com.amazon.network.privilege.gre

---

​

removeInterface()

void removeInterface(u8 interfaceId)

Remove a GRE/GRE-TAP tunnel interface. This is an asynchronous operation.

​

Parameters

interfaceId

u8 — Required the GRE interface identifier.

​

Throws

• SecurityError — if the app does not have the permission.
• InvalidArgumentError — if the interface is not a GRE interface.
• BaseError — on unexpected failure.

Requires com.amazon.network.privilege.gre

---

​

setMtu()

void setMtu(u8 interfaceId, u16 mtu)

Set the MTU on a GRE/GRE-TAP interface.

​

Parameters

interfaceId

u8 — Required the GRE interface identifier.

mtu

u16 — Required the MTU value to set.

​

Throws

• SecurityError — if the app does not have the permission.
• InvalidArgumentError — if the interface is not a GRE interface or mtu is invalid.
• BaseError — on unexpected failure.

Requires com.amazon.network.privilege.gre

---

​

getInfo()

GreInfo? getInfo(u8 interfaceId)

Get the complete information about a GRE/GRE-TAP tunnel.

​

Parameters

interfaceId

u8 — Required the GRE interface identifier.

​

Returns

GreInfo? The return value is optional and might be absent. the GRE tunnel information.

​

Throws

• SecurityError — if the app does not have the permission.
• InvalidArgumentError — if the interface is not a GRE interface.
• BaseError — on unexpected failure.

Requires com.amazon.network.privilege.gre

---

​

setBridgeMode()

void setBridgeMode(bool enable)

Enable or disable bridge mode globally. This is an asynchronous operation on the default GRE interface.

​

Parameters

enable

bool — Required true to enable bridge mode, false to disable.

​

Throws

• SecurityError — if the app does not have the permission.
• BaseError — on unexpected failure.

Requires com.amazon.network.privilege.gre

---

​

getBridgeMode()

bool getBridgeMode()

Get the current bridge mode state.

​

Returns

bool true if bridge mode is enabled.

​

Throws

• SecurityError — if the app does not have the permission.
• BaseError — on unexpected failure.

Requires com.amazon.network.privilege.gre

---