[lttng-ust.git] / liblttng-ust-java-agent / java / lttng-ust-agent-common / org / lttng / ust / agent / context / LttngContextApi.java

/*
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (C) 2016 EfficiOS Inc.
 * Copyright (C) 2016 Alexandre Montplaisir <alexmonthy@efficios.com>
 */

package org.lttng.ust.agent.context;

/**
 * Virtual class containing the Java side of the LTTng-UST context provider
 * registering/unregistering methods.
 *
 * @author Alexandre Montplaisir
 */
final class LttngContextApi {

	private LttngContextApi() {}

	/**
	 * Register a context provider to UST.
	 *
	 * The callbacks are the same for all providers, and are defined in the .c
	 * file. The only needed information is the retriever (which is called
	 * "provider" from UST'S point of view) name.
	 *
	 * @param provider_name
	 *            The name of the provider
	 * @return The pointer to the created provider object. It's useless in the
	 *         Java space, but will be needed for
	 *         {@link #unregisterProvider(long)}.
	 */
	static native long registerProvider(String provider_name);

	/**
	 * Unregister a previously-registered context provider from UST.
	 *
	 * @param provider_ref
	 *            The pointer to the provider object, obtained from
	 *            {@link #registerProvider}
	 */
	static native void unregisterProvider(long provider_ref);
}
Commit	Line	Data
8ab5c06b	1	/*
c0c0989a	2	* SPDX-License-Identifier: LGPL-2.1-only
8ab5c06b	3	*
c0c0989a MJ	4	* Copyright (C) 2016 EfficiOS Inc.
c0c0989a MJ	5	* Copyright (C) 2016 Alexandre Montplaisir <alexmonthy@efficios.com>
8ab5c06b AM	6	*/
	7
	8	package org.lttng.ust.agent.context;
	9
	10	/**
	11	* Virtual class containing the Java side of the LTTng-UST context provider
	12	* registering/unregistering methods.
	13	*
	14	* @author Alexandre Montplaisir
	15	*/
	16	final class LttngContextApi {
	17
	18	private LttngContextApi() {}
	19
	20	/**
	21	* Register a context provider to UST.
	22	*
	23	* The callbacks are the same for all providers, and are defined in the .c
	24	* file. The only needed information is the retriever (which is called
	25	* "provider" from UST'S point of view) name.
	26	*
	27	* @param provider_name
	28	* The name of the provider
	29	* @return The pointer to the created provider object. It's useless in the
	30	* Java space, but will be needed for
	31	* {@link #unregisterProvider(long)}.
	32	*/
	33	static native long registerProvider(String provider_name);
	34
	35	/**
	36	* Unregister a previously-registered context provider from UST.
	37	*
	38	* @param provider_ref
	39	* The pointer to the provider object, obtained from
	40	* {@link #registerProvider}
	41	*/
	42	static native void unregisterProvider(long provider_ref);
	43	}
	44