Arp::System::Commons::Ipc Namespace Reference

Namespace for class, enumerations and functions dealing with interprocess communication functionality. More...

Classes
class	AutoResetEvent
	Ipc-ready variant of Arp::System::Commons::Threading::AutoResetEvent More...
class	IpcSocket
	Socket for interprocess communication between processes on the same controller. More...
class	MessageQueue
	Message queues allow processes to exchange data in form of messages More...
struct	PeerCredentials
	This struct holds credentials of a UnixDomainSocket Peer More...
class	SharedData
class	SharedDataSettings
class	SharedMemory
	API to manage and manipulate memory shared between different processes More...

Enumerations
enum class	IpcSocketError {   None = 0 , Any = -1 , Success = 0 , Unspecified = -1 ,   Interrupted = (10000 + 4) , InvalidArgument = (10000 + 22) , TooManyOpenSockets = (10000 + 24) , WouldBlock = (10000 + 35) ,   InProgress = (10000 + 36) , AlreadyInProgress = (10000 + 37) , NotSocket = (10000 + 38) , DestinationAddressRequired = (10000 + 39) ,   MessageSize = (10000 + 40) , ProtoType = (10000 + 41) , ProtocolOption = (10000 + 42) , ProtocolNotSupported = (10000 + 43) ,   SocketNotSupported = (10000 + 44) , OperationNotSupported = (10000 + 45) , ProtocolFamilyNotSupported = (10000 + 46) , AddressFamilyNotSupported = (10000 + 47) ,   AddressAlreadyInUse = (10000 + 48) , AddressNotAvailable = (10000 + 49) , NetworkDown = (10000 + 50) , NetworkUnreachable = (10000 + 51) ,   NetworkReset = (10000 + 52) , ConnectionAborted = (10000 + 53) , ConnectionReset = (10000 + 54) , NoBufferSpaceAvailable = (10000 + 55) ,   IsConnected = (10000 + 56) , NotConnected = (10000 + 57) , Shutdown = (10000 + 58) , TimedOut = (10000 + 60) ,   ConnectionRefused = (10000 + 61) , HostDown = (10000 + 64) , HostUnreachable = (10000 + 65) , ProcessLimit = (10000 + 67) ,   SystemNotReady = (10000 + 91) , VersionNotSupported = (10000 + 92) , NotInitialized = (10000 + 93) , Disconnecting = (10000 + 101) ,   HostNotFound = (10000 + 1001) , TryAgain = (10000 + 1002) }
	Enumeration of possible error return codes from IpcSocket operations. More...

Detailed Description

Namespace for class, enumerations and functions dealing with interprocess communication functionality.

Enumeration Type Documentation

IpcSocketError

enum class Arp::System::Commons::Ipc::IpcSocketError

strong

Enumeration of possible error return codes from IpcSocket operations.

Enumerator
None	The Socket operation succeeded.
Any	An unspecified Socket error has occurred.
Success	The Socket operation succeeded.
Unspecified	An unspecified Socket error has occurred.
Interrupted	A blocking operation was interrupted.
InvalidArgument	An invalid argument was supplied.
TooManyOpenSockets	Too many open sockets.
WouldBlock	A non-blocking socket operation could not be completed immediately.
InProgress	A blocking operation is currently executing.
AlreadyInProgress	An operation was attempted on a non-blocking socket that already had an operation in progress.
NotSocket	An operation was attempted on something that is not a socket.
DestinationAddressRequired	A required address was omitted from an operation on a socket.
MessageSize	A message sent on a datagram socket was larger than the internal message buffer or some other network limit, or the buffer used to receive a datagram into was smaller than the datagram itself.
ProtoType	A protocol was specified in the socket function call that does not support the semantics of the socket type requested.
ProtocolOption	An unknown, invalid, or unsupported option or level was specified in a getsockopt or setsockopt call.
ProtocolNotSupported	The requested protocol has not been configured into the system, or no implementation for it exists.
SocketNotSupported	The support for the specified socket type does not exist in this address family.
OperationNotSupported	The attempted operation is not supported for the type of object referenced.
ProtocolFamilyNotSupported	The protocol family has not been configured into the system or no implementation for it exists.
AddressFamilyNotSupported	An address incompatible with the requested protocol was used.
AddressAlreadyInUse	Only one usage of each socket address (protocol/network address/port) is normally permitted.
AddressNotAvailable	The requested address is not valid in its context.
NetworkDown	A socket operation encountered a dead network.
NetworkUnreachable	A socket operation was attempted to an unreachable network.
NetworkReset	The connection has been broken due to keep-alive activity detecting a failure while the operation was in progress.
ConnectionAborted	An established connection was aborted by the software in your host machine.
ConnectionReset	An existing connection was forcibly closed by the remote host.
NoBufferSpaceAvailable	An operation on a socket could not be performed because the system lacked sufficient buffer space or because a queue was full.
IsConnected	A connect request was made on an already connected socket.
NotConnected	A request to send or receive data was disallowed because the socket is not connected and (when sending on a datagram socket using a sendto call) no address was supplied.
Shutdown	A request to send or receive data was disallowed because the socket had already been shut down in that direction with a previous shutdown call.
TimedOut	A connection attempt failed because the connected party did not properly respond after a period of time, or established connection failed because connected host has failed to respond.
ConnectionRefused	No connection could be made because the target machine actively refused it.
HostDown	A socket operation failed because the destination host was down.
HostUnreachable	A socket operation was attempted to an unreachable host.
ProcessLimit	A Sockets implementation may have a limit on the number of applications that may use it simultaneously.
SystemNotReady	Startup cannot function at this time because the underlying system it uses to provide network services is currently unavailable.
VersionNotSupported	The Sockets version requested is not supported.
NotInitialized	Either the application has not called Startup, or Startup failed.
Disconnecting	Returned by Recv or RecvFrom to indicate the remote party has initiated a graceful shutdown sequence.
HostNotFound	No such host is known.
TryAgain	This is usually a temporary error during host name resolution and means that the local server did not receive a response from an authoritative server.