PluginInit.h File Reference

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. More...

#include <atscppapi/utils.h>

Include dependency graph for PluginInit.h:

Go to the source code of this file.

Enumerations
enum	TsReturnCode { TS_ERROR = -1, TS_SUCCESS = 0 }
Functions
void	TSPluginInit (int argc, const char *argv[])
	Invoked for "general" plugins - listed in plugin.config.
TsReturnCode	TSRemapNewInstance (int argc, char *argv[], void **instance_handle, char *errbuf, int errbuf_size)
	Invoked for remap plugins - listed in remap.config.

---

Detailed Description

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.

See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Provides hooks that plugins have to implement. ATS will invoke these when loading the plugin .so files.

Definition in file PluginInit.h.

---

Enumeration Type Documentation

enum TsReturnCode

Enumerator:

TS_ERROR
TS_SUCCESS

Definition at line 40 of file PluginInit.h.

---

Function Documentation

void TSPluginInit	(	int	argc,
		const char *	argv[]
	)

Invoked for "general" plugins - listed in plugin.config.

The arguments in the plugin.config line are provided in this invocation.

Parameters:

	argc	Count of arguments
	argv	Array of pointers pointing to arguments

TsReturnCode TSRemapNewInstance	(	int	argc,
		char *	argv[],
		void **	instance_handle,
		char *	errbuf,
		int	errbuf_size
	)

Invoked for remap plugins - listed in remap.config.

The arguments provided as in the remap.config line are provided in this invocation.

Parameters:

	argc	Count of arguments
	argv	Array of pointers pointing to arguments
	instance_handle	Should be passed to the RemapPlugin constructor
	errbuf	Not used
	errbuf_size	Not used