Page tree

Have questions? Stuck? Please check our FAQ for some common questions and answers.

Skip to end of metadata
Go to start of metadata

UrlFnService - URL Function Service

UrlFnService is an Angular Factory in the Remote module with the name urlfn.js. It provides functions that build rest and websocket URLs for rest and websocket requests. To use these functions, see the documentation on injecting Angular services.

NameSummary
rsUrlConstruct a URL for rest calls.
wsUrlConstruct a URL for websocket calls.

Function Descriptions

rsUrl

Example UsageArgumentsReturn Value
ufs.rsUrl(path);path - string of the path you want the rest call to send a request to

a string of the form:

http[s]://<HOST>:<PORT>/onos/ui/rs/path

[s] – if applicable

wsUrl

Example UsageArgumentsReturn Value
ufs.wsUrl(path, wsport, host);

path - string of the path you want the websocket call to send a request to

wsport - the websocket port (undefined will use the current port)

host - the websocket host (undefined will use the current host)

a string of the form:

ws[s]://host:port/onos/ui/websock/path

[s] – if applicable

  • No labels