#include <ProcessUtils.h>

Inheritance diagram for ProcessUtils::SubProcess:

Public Member Functions
	SubProcess (const char exePath, DWORD timeOutMS=60 1000)

	~SubProcess ()

void	Detach ()

bool	IsRunning () const

	PFC_DECLARE_EXCEPTION (failure, std::exception,"Unexpected failure")

size_t	read (void *p_buffer, size_t p_bytes, abort_callback &abort)

void	Restart ()

void	SetPriority (DWORD val)

void	write (const void *p_buffer, size_t p_bytes, abort_callback &abort)

Data Fields
bool	ProcessMessages

DWORD	TimeOutMS

Protected Member Functions
void	CleanUp (bool bDetach=false)

Protected Attributes
const pfc::string8	ExePath

HANDLE	hEventRead

HANDLE	hEventWrite

HANDLE	hProcess

HANDLE	hStdIn

HANDLE	hStdOut

Static Private Member Functions
static void	_Close (HANDLE &h)

static pfc::string_formatter	makePipeName ()

static void	myCreatePipe (HANDLE &in, HANDLE &out)

static void	myCreatePipeIn (HANDLE &in, HANDLE &out)

static void	myCreatePipeOut (HANDLE &in, HANDLE &out)

Detailed Description

Definition at line 133 of file ProcessUtils.h.

Constructor & Destructor Documentation

ProcessUtils::SubProcess::SubProcess	(	const char *	exePath,
		DWORD	timeOutMS = `60*1000`
	)

inline

Definition at line 137 of file ProcessUtils.h.

                                                                     : ExePath(exePath), hStdIn(), hStdOut(), hProcess(), ProcessMessages(false), TimeOutMS(timeOutMS) {
             HANDLE ev;
             WIN32_OP( (ev = CreateEvent(NULL, TRUE, FALSE, NULL)) != NULL );
             hEventRead = ev;
             WIN32_OP( (ev = CreateEvent(NULL, TRUE, FALSE, NULL)) != NULL );
             hEventWrite = ev;
             Restart();
         }

ProcessUtils::SubProcess::~SubProcess ( )

inline

Definition at line 172 of file ProcessUtils.h.

                       {
             CleanUp();
             CloseHandle(hEventRead);
             CloseHandle(hEventWrite);
         }

Member Function Documentation

static void ProcessUtils::SubProcess::_Close ( HANDLE & h )

inlinestaticprivate

Definition at line 217 of file ProcessUtils.h.

                                        {
             if (h != NULL) {CloseHandle(h); h = NULL;}
         }

void ProcessUtils::SubProcess::CleanUp ( bool bDetach = false )

inlineprotected

Definition at line 203 of file ProcessUtils.h.

                                            {
             _Close(hStdIn); _Close(hStdOut);
             if (hProcess != NULL) {
                 if (!bDetach) {
                     if (WaitForSingleObject(hProcess, TimeOutMS) != WAIT_OBJECT_0) {
                         //PFC_ASSERT( !"Should not get here - worker stuck" );
                         console::formatter() << pfc::string_filename_ext(ExePath) << " unresponsive - terminating";
                         TerminateProcess(hProcess, -1);
                     }
                 }
                 _Close(hProcess);
             }
         }

void ProcessUtils::SubProcess::Detach ( )

inline

Definition at line 181 of file ProcessUtils.h.

                       {
             CleanUp(true);
         }

bool ProcessUtils::SubProcess::IsRunning ( ) const

inline

Definition at line 178 of file ProcessUtils.h.

                                {
             return hProcess != NULL;
         }

static pfc::string_formatter ProcessUtils::SubProcess::makePipeName ( )

inlinestaticprivate

Definition at line 226 of file ProcessUtils.h.

                                                   {
             GUID id;
             CoCreateGuid (&id);
             return pfc::string_formatter() << "\\\\.\\pipe\\" << pfc::print_guid(id);
         }

static void ProcessUtils::SubProcess::myCreatePipe	(	HANDLE &	in,
		HANDLE &	out
	)

inlinestaticprivate

Definition at line 221 of file ProcessUtils.h.

                                                             {
             SECURITY_ATTRIBUTES Attributes = { sizeof(SECURITY_ATTRIBUTES), 0, true };
             WIN32_OP( CreatePipe( &in, &out, &Attributes, 0 ) );
         }

static void ProcessUtils::SubProcess::myCreatePipeIn	(	HANDLE &	in,
		HANDLE &	out
	)

inlinestaticprivate

Definition at line 251 of file ProcessUtils.h.

                                                               {
             SECURITY_ATTRIBUTES Attributes = { sizeof(SECURITY_ATTRIBUTES), 0, true };
             const pfc::stringcvt::string_os_from_utf8 pipeName( makePipeName() );
             SetLastError(NO_ERROR);
             HANDLE pipe = CreateNamedPipe(
                 pipeName,
                 FILE_FLAG_FIRST_PIPE_INSTANCE | PIPE_ACCESS_INBOUND | FILE_FLAG_OVERLAPPED,
                 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT,
                 1,
                 1024*64,
                 1024*64,
                 NMPWAIT_USE_DEFAULT_WAIT,&Attributes);
             if (pipe == INVALID_HANDLE_VALUE) throw exception_win32(GetLastError());
             
             out = CreateFile(pipeName,GENERIC_WRITE,FILE_SHARE_READ|FILE_SHARE_WRITE,&Attributes,OPEN_EXISTING,0,NULL);
             DuplicateHandle ( GetCurrentProcess(), pipe, GetCurrentProcess(), &in, 0, FALSE, DUPLICATE_SAME_ACCESS );
             CloseHandle(pipe);
         }

static void ProcessUtils::SubProcess::myCreatePipeOut	(	HANDLE &	in,
		HANDLE &	out
	)

inlinestaticprivate

Definition at line 232 of file ProcessUtils.h.

                                                                {
             SECURITY_ATTRIBUTES Attributes = { sizeof(SECURITY_ATTRIBUTES), 0, true };
             const pfc::stringcvt::string_os_from_utf8 pipeName( makePipeName() );
             SetLastError(NO_ERROR);
             HANDLE pipe = CreateNamedPipe(
                 pipeName,
                 FILE_FLAG_FIRST_PIPE_INSTANCE | PIPE_ACCESS_OUTBOUND | FILE_FLAG_OVERLAPPED,
                 PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT,
                 1,
                 1024*64,
                 1024*64,
                 NMPWAIT_USE_DEFAULT_WAIT,&Attributes);
             if (pipe == INVALID_HANDLE_VALUE) throw exception_win32(GetLastError());
             
             in = CreateFile(pipeName,GENERIC_READ,FILE_SHARE_READ|FILE_SHARE_WRITE,&Attributes,OPEN_EXISTING,0,NULL);
             DuplicateHandle ( GetCurrentProcess(), pipe, GetCurrentProcess(), &out, 0, FALSE, DUPLICATE_SAME_ACCESS );
             CloseHandle(pipe);
         }

ProcessUtils::SubProcess::PFC_DECLARE_EXCEPTION	(	failure	,
		std::exception	,
		"Unexpected failure"
	)

size_t ProcessUtils::SubProcess::read	(	void *	p_buffer,
		size_t	p_bytes,
		abort_callback &	abort
	)

inline

Definition at line 192 of file ProcessUtils.h.

                                                                             {
             PipeIO reader(hStdOut, hEventRead, ProcessMessages, TimeOutMS);
             return reader.read(p_buffer, p_bytes, abort);
         }

void ProcessUtils::SubProcess::Restart ( )

inline

Definition at line 145 of file ProcessUtils.h.

                        {
             CleanUp();
             STARTUPINFO si = {};
             try {
                 si.cb = sizeof(si);
                 si.dwFlags = STARTF_USESTDHANDLES | STARTF_FORCEOFFFEEDBACK;
                 //si.wShowWindow = SW_HIDE;
 
                 myCreatePipeOut(si.hStdInput, hStdIn);
                 myCreatePipeIn(hStdOut, si.hStdOutput);
                 si.hStdError = GetStdHandle(STD_ERROR_HANDLE);
 
                 PROCESS_INFORMATION pi = {};
                 try {
                     WIN32_OP( CreateProcess(pfc::stringcvt::string_os_from_utf8(ExePath), NULL, NULL, NULL, TRUE, 0, NULL, NULL, &si, &pi) );
                 } catch(std::exception const & e) {
                     throw failure(pfc::string_formatter() << "Could not start the worker process - " << e);
                 }
                 hProcess = pi.hProcess; _Close(pi.hThread);
             } catch(...) {
                 _Close(si.hStdInput);
                 _Close(si.hStdOutput);
                 CleanUp(); throw;
             }
             _Close(si.hStdInput);
             _Close(si.hStdOutput);
         }

void ProcessUtils::SubProcess::SetPriority ( DWORD val )

inline

Definition at line 196 of file ProcessUtils.h.

                                     {
             SetPriorityClass(hProcess, val);
         }

void ProcessUtils::SubProcess::write	(	const void *	p_buffer,
		size_t	p_bytes,
		abort_callback &	abort
	)

inline

Definition at line 188 of file ProcessUtils.h.

                                                                                  {
             PipeIO writer(hStdIn, hEventWrite, ProcessMessages, TimeOutMS);
             writer.write(p_buffer, p_bytes, abort);
         }

Field Documentation

const pfc::string8 ProcessUtils::SubProcess::ExePath

protected

Definition at line 201 of file ProcessUtils.h.

HANDLE ProcessUtils::SubProcess::hEventRead

protected

Definition at line 200 of file ProcessUtils.h.

HANDLE ProcessUtils::SubProcess::hEventWrite

protected

Definition at line 200 of file ProcessUtils.h.

HANDLE ProcessUtils::SubProcess::hProcess

protected

Definition at line 200 of file ProcessUtils.h.

HANDLE ProcessUtils::SubProcess::hStdIn

protected

Definition at line 200 of file ProcessUtils.h.

HANDLE ProcessUtils::SubProcess::hStdOut

protected

Definition at line 200 of file ProcessUtils.h.

bool ProcessUtils::SubProcess::ProcessMessages

Definition at line 184 of file ProcessUtils.h.

DWORD ProcessUtils::SubProcess::TimeOutMS

Definition at line 185 of file ProcessUtils.h.

The documentation for this class was generated from the following file:

foobar2000/helpers/ProcessUtils.h

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation