service_matcher.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed 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.
*/
 
#ifndef SERVICE_MATCHER_H
#define SERVICE_MATCHER_H
 
#include "grassroots_service_manager_library.h"
#include "data_resource.h"
#include "handler.h"
#include "service.h"
 
struct ServiceMatcher;
 
 
typedef bool (*RunServiceMatcherCallback) (struct ServiceMatcher *matcher_p, Service *service_p);
 
typedef void (*DestroyServiceMatcherCallback) (struct ServiceMatcher *matcher_p);
 
 
typedef struct ServiceMatcher
{
  RunServiceMatcherCallback sm_match_fn;
 
  DestroyServiceMatcherCallback sm_destroy_fn;
} ServiceMatcher;
 
 
typedef struct ResourceServiceMatcher
{
  ServiceMatcher rsm_base_matcher;
 
  DataResource *rsm_resource_p;
 
  Handler *rsm_handler_p;
} ResourceServiceMatcher;
 
 
typedef struct NameServiceMatcher
{
  ServiceMatcher nsm_base_matcher;
 
  const char *nsm_service_name_s;
 
  const char *nsm_service_alias_s;
} NameServiceMatcher;
 
 
typedef struct PluginNameServiceMatcher
{
  ServiceMatcher pnsm_base_matcher;
 
  const char *pnsm_plugin_name_s;
} PluginNameServiceMatcher;
 
 
typedef struct PluginOperationNameServiceMatcher
{
  PluginNameServiceMatcher ponsm_base_matcher;
 
  const char *ponsm_operation_name_s;
} PluginOperationNameServiceMatcher;
 
 
typedef struct KeywordServiceMatcher
{
  ServiceMatcher ksm_base_matcher;
} KeywordServiceMatcher;
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceMatcher *AllocateServiceMatcher(void);
 
GRASSROOTS_SERVICE_MANAGER_API ServiceMatcher *
AllocateResourceServiceMatcher(DataResource *resource_p, Handler *handler_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceMatcher *
AllocateOperationNameServiceMatcher(const char *name_s, const char *alias_s);
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceMatcher *
AllocatePluginNameServiceMatcher(const char *plugin_name_s);
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceMatcher *AllocatePluginOperationNameServiceMatcher(const char *plugin_name_s, const char *service_name_s);
 
 
GRASSROOTS_SERVICE_MANAGER_API ServiceMatcher *AllocateKeywordServiceMatcher (void);
 
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void InitServiceMatcher(ServiceMatcher *matcher_p, RunServiceMatcherCallback match_fn);
 
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void InitResourceServiceMatcher (ResourceServiceMatcher *matcher_p, DataResource *resource_p, Handler *handler_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void InitOperationNameServiceMatcher (NameServiceMatcher *matcher_p, const char *name_s, const char *alias_s);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void InitPluginNameServiceMatcher (PluginNameServiceMatcher *matcher_p, const char *plugin_name_s);
 
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void InitPluginOperationNameServiceMatcher (PluginOperationNameServiceMatcher *matcher_p, const char *plugin_name_s, const char *operation_name_s);
 
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void InitKeywordServiceMatcher (KeywordServiceMatcher *matcher_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API void SetPluginNameForServiceMatcher (PluginNameServiceMatcher *matcher_p, const char *plugin_name_s);
 
 
GRASSROOTS_SERVICE_MANAGER_API bool RunServiceMatcher (ServiceMatcher *matcher_p, Service *service_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL bool MatchServiceByName (ServiceMatcher *matcher_p, Service *service_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL bool MatchServiceByNameOrAlias (ServiceMatcher *matcher_p, Service *service_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL bool MatchServiceByResource (ServiceMatcher *matcher_p, Service *service_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL bool MatchServiceByPluginName (ServiceMatcher *matcher_p, Service *service_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL bool MatchServiceByPluginAndOperationsName (ServiceMatcher *matcher_p, Service *service_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL bool MatchServiceByKeyword (ServiceMatcher *matcher_p, Service *service_p);
 
 
GRASSROOTS_SERVICE_MANAGER_API void FreeServiceMatcher (ServiceMatcher *matcher_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void FreeResourceServiceMatcher (ServiceMatcher *matcher_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void FreeNameServiceMatcher (ServiceMatcher *matcher_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void FreePluginNameServiceMatcher (ServiceMatcher *matcher_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void FreePluginOperationNameServiceMatcher (ServiceMatcher *matcher_p);
 
GRASSROOTS_SERVICE_MANAGER_LOCAL void FreeKeywordServiceMatcher (ServiceMatcher *matcher_p);
 
 
#ifdef __cplusplus
}
#endif
 
#endif    /* #ifndef SERVICE_MATCHER_H */