std::experimental::filesystem::is_socket - cppreference.com (original) (raw)

Checks if the given file status or path corresponds to a named IPC socket, as if determined by the POSIX S_IFSOCK.

1. Equivalent to s.type() == file_type::socket.

2. Equivalent to is_socket(status(p)) or is_socket(status(p, ec)).

[edit] Parameters

[edit] Return value

true if the file indicated by p or if the type indicated s refers to a named socket. The non-throwing overload returns false if an error occurs.

[edit] Exceptions

1. The overload that does not take an error_code& parameter throws filesystem_error on underlying OS API errors, constructed with p as the first argument and the OS error code as the error code argument. std::bad_alloc may be thrown if memory allocation fails. The overload taking an error_code& parameter sets it to the OS API error code if an OS API call fails, and executes ec.clear() if no errors occur. This overload has

[edit] Notes

Named sockets are UNIX domain sockets constructed with socket and bind POSIX APIs, which may be used for advanced interprocess communication. In particular, they may be used to transport open file descriptors from one running process to another.

The information provided by this function is usually also provided as a byproduct of directory iteration. During directory iteration, calling is_socket(*iterator) is less efficient than is_socket(iterator->status()).

[edit] Example

#include #include #include <experimental/filesystem> #include #include #include <sys/socket.h> #include <sys/stat.h> #include <sys/un.h> #include <unistd.h>   namespace fs = std::experimental::filesystem;   void demo_status(const fs::path& p, fs::file_status s) { std::cout << p; // alternative: switch(s.type()) { case fs::file_type::regular: ... } if (fs::is_regular_file(s)) std::cout << " is a regular file\n"; if (fs::is_directory(s)) std::cout << " is a directory\n"; if (fs::is_block_file(s)) std::cout << " is a block device\n"; if (fs::is_character_file(s)) std::cout << " is a character device\n"; if (fs::is_fifo(s)) std::cout << " is a named IPC pipe\n"; if (fs::is_socket(s)) std::cout << " is a named IPC socket\n"; if (fs::is_symlink(s)) std::cout << " is a symlink\n"; if (!fs::exists(s)) std::cout << " does not exist\n"; }   int main() { // create files of different kinds fs::create_directory("sandbox"); std::ofstream("sandbox/file"); // create regular file fs::create_directory("sandbox/dir"); mkfifo("sandbox/pipe", 0644); struct sockaddr_un addr; addr.sun_family = AF_UNIX; std::strcpy(addr.sun_path, "sandbox/sock"); int fd = socket(PF_UNIX, SOCK_STREAM, 0); bind(fd, (struct sockaddr*)&addr, sizeof addr); fs::create_symlink("file", "sandbox/symlink");   // demo different status accessors for (auto it = fs::directory_iterator("sandbox"); it != fs::directory_iterator(); ++it) demo_status(*it, it->symlink_status()); // use cached status from directory entry demo_status("dev/null", fs::status("/dev/null")); // direct calls to status demo_status("dev/sda", fs::status("/dev/sda")); demo_status("sandbox/no", fs::status("/sandbox/no"));   // cleanup close(fd); fs::remove_all("sandbox"); }

Possible output:

"sandbox/file" is a regular file "sandbox/dir" is a directory "sandbox/pipe" is a named IPC pipe "sandbox/sock" is a named IPC socket "sandbox/symlink" is a symlink "dev/null" is a character device "dev/sda" is a block device "sandbox/no" does not exist

[edit] See also