[lttng-tools.git] / src / common / context.h

/*
 * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 only, as
 * published by the Free Software Foundation.
 *
 * This program 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 General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef LTTNG_COMMON_CONTEXT_H
#define LTTNG_COMMON_CONTEXT_H

#include <common/macros.h>

/*
 * Parse string as an application context of the form
 * "$app.provider_name:context_name" and return the provider name and context
 * name separately.
 *
 * provider_name and ctx_name are returned only if an application context name
 * was successfully parsed and must be freed by the caller.
 *
 * Returns 0 if the string is a valid application context, else a negative
 * value on error.
 */
LTTNG_HIDDEN
int parse_application_context(const char *str, char **provider_name,
		char **ctx_name);

#endif /* LTTNG_COMMON_CONTEXT_H */
Commit	Line	Data
	1	/*
	2	* Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License, version 2 only, as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc., 51
	15	* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#ifndef LTTNG_COMMON_CONTEXT_H
	19	#define LTTNG_COMMON_CONTEXT_H
	20
	21	#include <common/macros.h>
	22
	23	/*
	24	* Parse string as an application context of the form
	25	* "$app.provider_name:context_name" and return the provider name and context
	26	* name separately.
	27	*
	28	* provider_name and ctx_name are returned only if an application context name
	29	* was successfully parsed and must be freed by the caller.
	30	*
	31	* Returns 0 if the string is a valid application context, else a negative
	32	* value on error.
	33	*/
	34	LTTNG_HIDDEN
	35	int parse_application_context(const char str, char *provider_name,
	36	char **ctx_name);
	37
	38	#endif /* LTTNG_COMMON_CONTEXT_H */