namedpipe.h File Reference

Named pipe communication headers. More...

Go to the source code of this file.

Functions
HANDLE	NamedPipeServerCreatePipe (LPCSTR PipeName, UINT32 OutputBufferSize, UINT32 InputBufferSize)
	Create a named pipe server.
BOOLEAN	NamedPipeServerWaitForClientConnection (HANDLE PipeHandle)
	wait for client connection
UINT32	NamedPipeServerReadClientMessage (HANDLE PipeHandle, CHAR *BufferToSave, INT32 MaximumReadBufferLength)
	read client message from the named pipe
BOOLEAN	NamedPipeServerSendMessageToClient (HANDLE PipeHandle, CHAR *BufferToSend, INT32 BufferSize)
	Send a message to the client over named pipe.
VOID	NamedPipeServerCloseHandle (HANDLE PipeHandle)
	Close handle of server's named pipe.
HANDLE	NamedPipeClientCreatePipe (LPCSTR PipeName)
	Create a client named pipe.
BOOLEAN	NamedPipeClientSendMessage (HANDLE PipeHandle, CHAR *BufferToSend, INT32 BufferSize)
	Send client message over named pipe.
UINT32	NamedPipeClientReadMessage (HANDLE PipeHandle, CHAR *BufferToRead, INT32 MaximumSizeOfBuffer)
	Read a message from the server over named pipe.
VOID	NamedPipeClientClosePipe (HANDLE PipeHandle)
	close named pipe handle of client

Detailed Description

Named pipe communication headers.

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.1

Date

2020-04-11

Copyright

This project is released under the GNU Public License v3.

Function Documentation

NamedPipeClientClosePipe()

VOID NamedPipeClientClosePipe

(

HANDLE

PipeHandle

)

close named pipe handle of client

Parameters

PipeHandle

Returns

VOID

{
    CloseHandle(PipeHandle);
}

NamedPipeClientCreatePipe()

HANDLE NamedPipeClientCreatePipe

(

LPCSTR

PipeName

)

Create a client named pipe.

Pipe name format - \servername\pipe\pipename This pipe is for server on the same computer, however, pipes can be used to connect to a remote server

Parameters

PipeName

Returns

HANDLE

{
    HANDLE hPipe;
 
    //
    // Connect to the server pipe using CreateFile()
    //
    hPipe = CreateFileA(PipeName,      // pipe name
                        GENERIC_READ | // read and write access
                            GENERIC_WRITE,
                        0,             // no sharing
                        NULL,          // default security attributes
                        OPEN_EXISTING, // opens existing pipe
                        0,             // default attributes
                        NULL);         // no template file
 
    if (INVALID_HANDLE_VALUE == hPipe)
    {
        printf("err, occurred while connecting to the server (%x)\n",
               GetLastError());
        //
        // One might want to check whether the server pipe is busy
        // This sample will error out if the server pipe is busy
        // Read on ERROR_PIPE_BUSY and WaitNamedPipe() for that
        //
 
        //
        // Error
        //
        return NULL;
    }
    else
    {
        return hPipe;
    }
}

NamedPipeClientReadMessage()

UINT32 NamedPipeClientReadMessage	(	HANDLE	PipeHandle,
		CHAR *	BufferToRead,
		INT32	MaximumSizeOfBuffer )

Read a message from the server over named pipe.

Parameters

PipeHandle	Handle of the named pipe
BufferToRead	Buffer to store the received message
MaximumSizeOfBuffer	Maximum size of the receive buffer

Returns

UINT32 number of bytes read, or 0 on failure

{
    DWORD BytesTransferred;
 
    //
    // Read server response
    //
    BOOLEAN Result = ReadFile(PipeHandle,          // handle to pipe
                              BufferToRead,        // buffer to receive data
                              MaximumSizeOfBuffer, // size of buffer
                              &BytesTransferred,   // number of bytes read
                              NULL);               // not overlapped I/O
 
    if ((!Result) || (0 == BytesTransferred))
    {
        printf("err, occurred while reading from the server (%x)\n",
               GetLastError());
        CloseHandle(PipeHandle);
        return 0; // Error
    }
 
    //
    // Success
    //
    return BytesTransferred;
}

NamedPipeClientSendMessage()

BOOLEAN NamedPipeClientSendMessage	(	HANDLE	PipeHandle,
		CHAR *	BufferToSend,
		INT32	BufferSize )

Send client message over named pipe.

Parameters

PipeHandle	Handle of the named pipe
BufferToSend	Buffer containing the message to send
BufferSize	Size of the buffer to send

Returns

BOOLEAN TRUE if successful, FALSE otherwise

{
    //
    // We are done connecting to the server pipe,
    // we can start communicating with
    // the server using ReadFile()/WriteFile()
    // on handle - hPipe
    //
 
    DWORD BytesTransferred;
 
    //
    // Send the message to server
    //
    BOOLEAN Result =
        WriteFile(PipeHandle,        // handle to pipe
                  BufferToSend,      // buffer to write from
                  BufferSize,        // number of bytes to write, include the NULL
                  &BytesTransferred, // number of bytes written
                  NULL);             // not overlapped I/O
 
    if ((!Result) || (BufferSize != (INT32)BytesTransferred))
    {
        printf("err, occurred while writing to the server (%x)\n",
               GetLastError());
        CloseHandle(PipeHandle);
 
        //
        // Error
        //
        CloseHandle(PipeHandle);
        return FALSE;
    }
    else
    {
        return TRUE;
    }
}

NamedPipeServerCloseHandle()

VOID NamedPipeServerCloseHandle

(

HANDLE

PipeHandle

)

Close handle of server's named pipe.

Parameters

PipeHandle

Returns

VOID

{
    CloseHandle(PipeHandle);
}

NamedPipeServerCreatePipe()

HANDLE NamedPipeServerCreatePipe	(	LPCSTR	PipeName,
		UINT32	OutputBufferSize,
		UINT32	InputBufferSize )

Create a named pipe server.

Parameters

PipeName
OutputBufferSize
InputBufferSize

Returns

HANDLE

{
    HANDLE hPipe;
 
    hPipe = CreateNamedPipeA(PipeName,                   // pipe name
                             PIPE_ACCESS_DUPLEX,         // read/write access
                             PIPE_TYPE_MESSAGE |         // message type pipe
                                 PIPE_READMODE_MESSAGE | // message-read mode
                                 PIPE_WAIT,              // blocking mode
                             PIPE_UNLIMITED_INSTANCES,   // max. instances
                             OutputBufferSize,           // output buffer size
                             InputBufferSize,            // input buffer size
                             NMPWAIT_USE_DEFAULT_WAIT,   // client time-out
                             NULL);                      // default security attribute
 
    if (INVALID_HANDLE_VALUE == hPipe)
    {
        printf("err, occurred while creating the pipe (%x)\n",
               GetLastError());
        return NULL;
    }
    return hPipe;
}

NamedPipeServerReadClientMessage()

UINT32 NamedPipeServerReadClientMessage	(	HANDLE	PipeHandle,
		CHAR *	BufferToSave,
		INT32	MaximumReadBufferLength )

read client message from the named pipe

Parameters

PipeHandle
BufferToSave
MaximumReadBufferLength

Returns

UINT32

{
    DWORD BytesTransferred;
 
    //
    // We are connected to the client.
    // To communicate with the client
    // we will use ReadFile()/WriteFile()
    // on the pipe handle - hPipe
    //
 
    //
    // Read client message
    //
    BOOLEAN Result = ReadFile(PipeHandle,              // handle to pipe
                              BufferToSave,            // buffer to receive data
                              MaximumReadBufferLength, // size of buffer
                              &BytesTransferred,       // number of bytes read
                              NULL);                   // not overlapped I/O
 
    if ((!Result) || (0 == BytesTransferred))
    {
        printf("err, occurred while reading from the client (%x)\n",
               GetLastError());
        CloseHandle(PipeHandle);
        return 0;
    }
 
    //
    // Number of bytes that the client sends to us
    //
    return BytesTransferred;
}

NamedPipeServerSendMessageToClient()

BOOLEAN NamedPipeServerSendMessageToClient	(	HANDLE	PipeHandle,
		CHAR *	BufferToSend,
		INT32	BufferSize )

Send a message to the client over named pipe.

Parameters

PipeHandle	Handle of the named pipe
BufferToSend	Buffer containing the message to send
BufferSize	Size of the buffer to send

Returns

BOOLEAN TRUE if successful, FALSE otherwise

{
    DWORD BytesTransferred;
 
    //
    // Reply to client
    //
    BOOLEAN Result =
        WriteFile(PipeHandle,        // handle to pipe
                  BufferToSend,      // buffer to write from
                  BufferSize,        // number of bytes to write, include the NULL
                  &BytesTransferred, // number of bytes written
                  NULL);             // not overlapped I/O
 
    if ((!Result) || (BufferSize != (INT32)BytesTransferred))
    {
        printf("err, occurred while writing to the client (%x)\n",
               GetLastError());
        CloseHandle(PipeHandle);
        return FALSE;
    }
    return TRUE;
}

NamedPipeServerWaitForClientConnection()

BOOLEAN NamedPipeServerWaitForClientConnection

(

HANDLE

PipeHandle

)

wait for client connection

Parameters

PipeHandle

Returns

BOOLEAN

{
    //
    // Wait for the client to connect
    //
    BOOLEAN ClientConnected = ConnectNamedPipe(PipeHandle, NULL);
 
    if (FALSE == ClientConnected)
    {
        printf("err, occurred while connecting to the client (%x)\n",
               GetLastError());
        CloseHandle(PipeHandle);
        return FALSE;
    }
 
    //
    // Client connected
    //
    return TRUE;
}