NetworkService
Inclusion code:
Service Deployment | |||
---|---|---|---|
Port Name | Location | Protocol | Interfaces |
NetworkService documentation: | |||
NetworkService | - | - | NetworkServiceInterface |
List of Available Interfaces
NetworkServiceInterface
Interface documentation:
Operation Name | Input Type | Output Type | Faults |
---|---|---|---|
getNetworkInterfaceNames | GetNetworkInterfaceNamesRequest | GetNetworkInterfaceNamesResponse | |
getIPAddresses | GetIPAddressesRequest | GetIPAddressesResponse | InterfaceNotFound( undefined ) |
Operation Description
getNetworkInterfaceNames
Operation documentation:
Invocation template:
getNetworkInterfaceNames@NetworkService( request )( response )
Request type
Type: GetNetworkInterfaceNamesRequest
GetNetworkInterfaceNamesRequest : void
Response type
Type: GetNetworkInterfaceNamesResponse
type GetNetworkInterfaceNamesResponse: void {
.interfaceName*: string {
.displayName: string
}
}
GetNetworkInterfaceNamesResponse : void
interfaceName : string
displayName : string
getIPAddresses
Operation documentation:
Invocation template:
getIPAddresses@NetworkService( request )( response )
Request type
Type: GetIPAddressesRequest
type GetIPAddressesRequest: void {
.interfaceName: string
}
GetIPAddressesRequest : void
interfaceName : string
Response type
Type: GetIPAddressesResponse
type GetIPAddressesResponse: void {
.ip4?: string
.ip6?: string
}
GetIPAddressesResponse : void
ip4 : string
ip6 : string
Possible faults thrown
Fault InterfaceNotFound
with type undefined
Fault-handling install template:
install ( InterfaceNotFound => /* error-handling code */ )