Avis Client Library: avis/elvin_uri.h File Reference

# avis/elvin_uri.h File Reference

## Detailed Description

Elvin URI handling.

`#include <avis/attributes.h>`
`#include <avis/arrays.h>`
`#include <avis/stdtypes.h>`
`#include <avis/errors.h>`
`#include <avis/defs.h>`

Go to the source code of this file.

## Data Structures
struct | ElvinURI
| A URI referring to an Elvin router endpoint. More...
## Defines
#define | DEFAULT_URI_PROTOCOL (_elvin_uri_default_protocol)
## Functions
AVIS_PUBLIC bool | elvin_uri_from_string (ElvinURI *uri, const char *uri_string, ElvinError *error)
| Parse a URI pointing to an Elvin router endpoint.
AVIS_PUBLIC void | elvin_uri_free (ElvinURI *uri)
| Free any resources allocated to a URI.
## Variables
AVIS_PUBLIC_DATA char * | _elvin_uri_default_protocol [3]

## Define Documentation

#define DEFAULT_URI_PROTOCOL (_elvin_uri_default_protocol)

## Function Documentation

AVIS_PUBLIC void elvin_uri_free | ( | ElvinURI * | uri | ) |

Free any resources allocated to a URI.

AVIS_PUBLIC bool elvin_uri_from_string | ( | ElvinURI * | uri,
|  | const char * | uri_string,
|  | ElvinError * | error |
| ) |  |  |

Parse a URI pointing to an Elvin router endpoint.

Parameters:

  | uri | The URI to initialise.
  | uri_string | The URI in text form.
  | error | The error info.

Example URI's:

     elvin://host
     elvin://host:port
     elvin:/xdr,none,ssl/host:port
     elvin:4.1/xdr,none,ssl/host:port
     elvin:4.1/xdr,none,ssl/host:port?n1=v1;n2=v2

See also:
  elvin_uri_free()

## Variable Documentation

AVIS_PUBLIC_DATA char* _elvin_uri_default_protocol[3]