oiourl.h

Go to the documentation of this file.

/*
OpenIO SDS core library
Copyright (C) 2014 Worldline, as part of Redcurrant
Copyright (C) 2015-2017 OpenIO SAS, as part of OpenIO SDS

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3.0 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library.
*/

#ifndef OIO_SDS__core__oiourl_h
# define OIO_SDS__core__oiourl_h 1

#include <glib.h>
#include <sys/types.h>

#ifdef __cplusplus
extern "C" {
#endif

enum oio_url_field_e
{
    OIOURL_NS=1,
    OIOURL_ACCOUNT = 2,
    OIOURL_USER = 3,
    /* DO NOT REUSE the value <4>, previously used as OIOURL_TYPE */
    OIOURL_PATH = 5,

    OIOURL_VERSION = 6,

    OIOURL_WHOLE = 7,  /* read-only */

    OIOURL_HEXID = 8,  /* read-write */
    OIOURL_CONTENTID = 9,  /* read-write */

    OIOURL_FULLPATH = 10
};

#define LIMIT_LENGTH_NSNAME 64

#define LIMIT_LENGTH_ACCOUNTNAME 64

#define LIMIT_LENGTH_CONTENTPATH 1024

#define LIMIT_LENGTH_VERSION 24

#define LIMIT_LENGTH_USER 1024


struct oio_url_s;

struct oio_url_s * oio_url_init(const char *url);

struct oio_url_s * oio_url_init_raw(const char *url);

struct oio_url_s * oio_url_empty(void);

struct oio_url_s* oio_url_dup(const struct oio_url_s *u);

void oio_url_clean(struct oio_url_s *u);

void oio_url_cleanv (struct oio_url_s **tab);

void oio_url_pclean(struct oio_url_s **pu);

struct oio_url_s* oio_url_set(struct oio_url_s *u,
        enum oio_url_field_e f, const char *v);

void oio_url_unset(struct oio_url_s *u, enum oio_url_field_e f);

const char * oio_url_get(struct oio_url_s *u, enum oio_url_field_e f);

int oio_url_has(const struct oio_url_s *u, enum oio_url_field_e f);

void oio_url_set_id(struct oio_url_s *u, const void *id);

/* the returned value points to an array of oio_url_get_id_size() bytes long. */
const void* oio_url_get_id(struct oio_url_s *u);

/* returns the number of bytes */
size_t oio_url_get_id_size(struct oio_url_s *u);

int oio_url_has_fq_path (const struct oio_url_s *u);

int oio_url_has_fq_container (const struct oio_url_s *u);

gboolean oio_url_check(const struct oio_url_s *u, const char *n, const gchar **e);

#ifdef __cplusplus
}
#endif

#endif /*OIO_SDS__core__oiourl_h*/