Document client socket path format for Windows

IntersectMBO / ouroboros-network

Specifications of network protocols and implementations of components running these protocols which support a family of Ouroboros Consesus protocols; the diffusion layer of the Cardano Node.

https://ouroboros-network.cardano.intersectmbo.org

Apache License 2.0

275 stars 87 forks source link

Document client socket path format for Windows #1834

Open coot opened 4 years ago

coot commented 4 years ago

https://docs.microsoft.com/en-us/windows/win32/ipc/pipe-names

dcoutts commented 4 years ago

https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-createnamedpipea

lpName

The unique pipe name. This string must have the following form:

\\.\pipe\pipename

The pipename part of the name can include any character other than a backslash, including numbers and special characters. The entire pipe name string can be up to 256 characters long. Pipe names are not case sensitive.

dcoutts commented 4 years ago

Summary:

${pipename} has to include an app name to avoid clashes with other applications, e.g. "cardano-node".
${pipename} should be different for different parallel-installable instances, e.g. mainnet vs testnet
default file permissions should be right: it'll be accessible to the same user