winss
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
winss::PipeName Class Reference

Pipe names are based on file system paths. More...

#include <pipe_name.hpp>

Public Member Functions

 PipeName (fs::path path)
 Creates a standard pipe name based on only a path. More...
 
 PipeName (fs::path path, std::string name)
 Creates a standard pipe name based on a path and service name. More...
 
 PipeName (const PipeName &p)
 Create a new path based on another path. More...
 
 PipeName (PipeName &&p)
 Create a new path based on another path. More...
 
PipeName Append (const std::string &name) const
 Append an additional name to the current pipe. More...
 
const std::string & Get () const
 Gets the pipe name as a string. More...
 
PipeNameoperator= (const PipeName &p)
 Copy another pipe name to this pipe name. More...
 
PipeNameoperator= (PipeName &&p)
 Move another pipe name to this pipe name. More...
 

Protected Member Functions

 PipeName ()
 The final pipe name. More...
 

Protected Attributes

std::string name
 

Detailed Description

Pipe names are based on file system paths.

This ensures that all pipes are created with a name that is in the same format.

Constructor & Destructor Documentation

winss::PipeName::PipeName ( )
inlineprotected

The final pipe name.

Avoid public access to empty pipe name.

References Append(), Get(), and operator=().

winss::PipeName::PipeName ( fs::path  path)
explicit

Creates a standard pipe name based on only a path.

Parameters
pathThe file system path.

References winss::SHA256::CalculateDigest(), FILESYSTEM, and name.

winss::PipeName::PipeName ( fs::path  path,
std::string  name 
)

Creates a standard pipe name based on a path and service name.

Parameters
pathThe file system path.
nameThe name of the service at the path.

References name.

winss::PipeName::PipeName ( const PipeName p)

Create a new path based on another path.

Parameters
pThe path to copy from.
winss::PipeName::PipeName ( winss::PipeName &&  p)

Create a new path based on another path.

Parameters
pThe path to move from.

Member Function Documentation

winss::PipeName winss::PipeName::Append ( const std::string &  name) const

Append an additional name to the current pipe.

Parameters
nameThe name to append.
Returns
The new pipe name.

References name.

Referenced by PipeName().

const std::string & winss::PipeName::Get ( ) const

Gets the pipe name as a string.

Returns
The pipe name as a string.

References name.

Referenced by winss::PipeInstance::CreateFile(), winss::PipeInstance::CreateNamedPipe(), and PipeName().

winss::PipeName & winss::PipeName::operator= ( const PipeName p)

Copy another pipe name to this pipe name.

Parameters
pThe other pipe name.
Returns
This pipe name.

References name.

Referenced by PipeName().

winss::PipeName & winss::PipeName::operator= ( winss::PipeName &&  p)

Move another pipe name to this pipe name.

Parameters
pThe other pipe name.
Returns
This pipe name.

References name.

Member Data Documentation

std::string winss::PipeName::name
protected

Referenced by Append(), Get(), operator=(), and PipeName().


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