| Current File : //usr/share/doc/net-snmp/html/winservice_8h_source.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>net-snmp: winservice.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">net-snmp
 <span id="projectnumber">5.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">winservice.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef WINSERVICE_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define WINSERVICE_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="comment">/*</span>
<a name="l00005"></a>00005 <span class="comment"> * </span>
<a name="l00006"></a>00006 <span class="comment"> * Windows Service related functions declaration</span>
<a name="l00007"></a>00007 <span class="comment"> * By Raju Krishanppa(raju_krishnappa@yahoo.com)</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> */</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00013"></a>00013 {
<a name="l00014"></a>00014
<a name="l00015"></a>00015 <span class="preprocessor">#endif </span><span class="comment">/* */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="comment">/*</span>
<a name="l00018"></a>00018 <span class="comment"> * Define Constants for Register, De-register , Run As service or Console mode</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020 <span class="preprocessor">#define REGISTER_SERVICE 0</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define UN_REGISTER_SERVICE 1</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define RUN_AS_SERVICE 2</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define RUN_AS_CONSOLE 3</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="comment">/*</span>
<a name="l00027"></a>00027 <span class="comment"> * Error levels returned when registering or unregistering the service</span>
<a name="l00028"></a>00028 <span class="comment"> */</span>
<a name="l00029"></a>00029 <span class="preprocessor">#define SERVICE_ERROR_NONE 0 </span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define SERVICE_ERROR_SCM_OPEN 1 </span><span class="comment">/* Can not open SCM */</span>
<a name="l00031"></a>00031 <span class="preprocessor">#define SERVICE_ERROR_CREATE_SERVICE 2 </span><span class="comment">/* Can not create service */</span>
<a name="l00032"></a>00032 <span class="preprocessor">#define SERVICE_ERROR_CREATE_REGISTRY_ENTRIES 3 </span><span class="comment">/* Can not create registry entries */</span>
<a name="l00033"></a>00033 <span class="preprocessor">#define SERVICE_ERROR_OPEN_SERVICE 4 </span><span class="comment">/* Can not open service (service does not exist) */</span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">/*</span>
<a name="l00036"></a>00036 <span class="comment"> * Define Message catalog ID</span>
<a name="l00037"></a>00037 <span class="comment"> * MessageId: DISPLAY_MSG</span>
<a name="l00038"></a>00038 <span class="comment"> * MessageText: %1.</span>
<a name="l00039"></a>00039 <span class="comment"> */</span>
<a name="l00040"></a>00040 <span class="preprocessor">#define DISPLAY_MSG 0x00000064L</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="comment">/*</span>
<a name="l00043"></a>00043 <span class="comment"> * Hint Value to SCM to wait before sending successive commands to service</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045 <span class="preprocessor">#define SCM_WAIT_INTERVAL 7000</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="comment">/*</span>
<a name="l00048"></a>00048 <span class="comment"> * Define Generic String Size, to hold Error or Information</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="preprocessor">#define MAX_STR_SIZE 1024</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span>
<a name="l00052"></a>00052 <span class="comment">/*</span>
<a name="l00053"></a>00053 <span class="comment"> * Delcare Global variables, which are visible to other modules </span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 <span class="keyword">extern</span> BOOL g_fRunningAsService;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">/*</span>
<a name="l00058"></a>00058 <span class="comment"> * Input parameter structure to thread </span>
<a name="l00059"></a>00059 <span class="comment"> */</span>
<a name="l00060"></a><a class="code" href="struct__InputParams.html">00060</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__InputParams.html">_InputParams</a>
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 DWORD Argc;
<a name="l00063"></a>00063 LPTSTR *Argv;
<a name="l00064"></a>00064 } <a class="code" href="struct__InputParams.html">InputParams</a>;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">/*</span>
<a name="l00067"></a>00067 <span class="comment"> * Define Service Related functions</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">/*</span>
<a name="l00071"></a>00071 <span class="comment"> * To register application as windows service with SCM </span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a>00073 <span class="keywordtype">int</span> RegisterService (LPCTSTR lpszServiceName,
<a name="l00074"></a>00074 LPCTSTR lpszServiceDisplayName,
<a name="l00075"></a>00075 LPCTSTR lpszServiceDescription, <a class="code" href="struct__InputParams.html">InputParams</a> * StartUpArg, <span class="keywordtype">int</span> quiet);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/*</span>
<a name="l00078"></a>00078 <span class="comment"> * To unregister service </span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <span class="keywordtype">int</span> UnregisterService (LPCSTR lpszServiceName, <span class="keywordtype">int</span> quiet);
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">/*</span>
<a name="l00083"></a>00083 <span class="comment"> * To parse command line for startup option </span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 INT ParseCmdLineForServiceOption (INT argc, TCHAR * argv[], <span class="keywordtype">int</span> *quiet);
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/*</span>
<a name="l00088"></a>00088 <span class="comment"> * To write to windows event log </span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090 VOID WriteToEventLog (WORD wType, LPCTSTR pszFormat, ...);
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="comment">/*</span>
<a name="l00093"></a>00093 <span class="comment"> * To display generic windows error </span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 VOID DisplayError (LPCTSTR pszTitle, <span class="keywordtype">int</span> quite);
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">/*</span>
<a name="l00098"></a>00098 <span class="comment"> * To update windows service status to SCM </span>
<a name="l00099"></a>00099 <span class="comment"> */</span>
<a name="l00100"></a>00100 <span class="keyword">static</span> BOOL UpdateServiceStatus (DWORD dwStatus, DWORD dwErrorCode,
<a name="l00101"></a>00101 DWORD dwWaitHint);
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">/*</span>
<a name="l00104"></a>00104 <span class="comment"> * To Report current service status to SCM </span>
<a name="l00105"></a>00105 <span class="comment"> */</span>
<a name="l00106"></a>00106 <span class="keyword">static</span> BOOL ReportCurrentServiceStatus (VOID);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">/*</span>
<a name="l00109"></a>00109 <span class="comment"> * Service Main function, Which will spawn a thread, and calls the</span>
<a name="l00110"></a>00110 <span class="comment"> * Service run part</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112 VOID WINAPI ServiceMain (DWORD argc, LPTSTR argv[]);
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">/*</span>
<a name="l00115"></a>00115 <span class="comment"> * To start Service </span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117
<a name="l00118"></a>00118 BOOL RunAsService (INT (*ServiceFunction) (INT, LPTSTR *));
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">/*</span>
<a name="l00121"></a>00121 <span class="comment"> * Call back function to process SCM Requests </span>
<a name="l00122"></a>00122 <span class="comment"> */</span>
<a name="l00123"></a>00123 VOID WINAPI ControlHandler (DWORD dwControl);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">/*</span>
<a name="l00126"></a>00126 <span class="comment"> * To Stop the service </span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 VOID ProcessServiceStop (VOID);
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="comment">/*</span>
<a name="l00131"></a>00131 <span class="comment"> * To Pause service </span>
<a name="l00132"></a>00132 <span class="comment"> */</span>
<a name="l00133"></a>00133 VOID ProcessServicePause (VOID);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="comment">/*</span>
<a name="l00136"></a>00136 <span class="comment"> * To Continue paused service </span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a>00138 VOID ProcessServiceContinue (VOID);
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="comment">/*</span>
<a name="l00141"></a>00141 <span class="comment"> * To send Current Service status to SCM when INTERROGATE command is sent </span>
<a name="l00142"></a>00142 <span class="comment"> */</span>
<a name="l00143"></a>00143 VOID ProcessServiceInterrogate (VOID);
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">/*</span>
<a name="l00146"></a>00146 <span class="comment"> * To allocate and Set security descriptor </span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 BOOL SetSimpleSecurityAttributes (SECURITY_ATTRIBUTES * pSecurityAttr);
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="comment">/*</span>
<a name="l00151"></a>00151 <span class="comment"> * To free Security Descriptor </span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 VOID FreeSecurityAttributes (SECURITY_ATTRIBUTES * pSecurityAttr);
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">/*</span>
<a name="l00156"></a>00156 <span class="comment"> * TheadFunction - To spawan as thread - Invokes registered service function </span>
<a name="l00157"></a>00157 <span class="comment"> */</span>
<a name="l00158"></a>00158 DWORD WINAPI ThreadFunction (LPVOID lpParam);
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="comment">/*</span>
<a name="l00161"></a>00161 <span class="comment"> * Service STOP function registration with this framewrok</span>
<a name="l00162"></a>00162 <span class="comment"> * * this function must be invoked before calling RunAsService</span>
<a name="l00163"></a>00163 <span class="comment"> */</span>
<a name="l00164"></a>00164 VOID RegisterStopFunction (VOID (*StopFunc) (VOID));
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00167"></a>00167 <span class="preprocessor"></span>}
<a name="l00168"></a>00168 <span class="preprocessor">#endif </span><span class="comment">/* */</span>
<a name="l00169"></a>00169 <span class="preprocessor">#endif </span><span class="comment">/* WINSERVICE_H */</span>
<a name="l00170"></a>00170
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>