SocketHandle Class Reference

A FileHandle customized with some socket specific functionality and functions. More...

#include <SocketHandle.h>

Inheritance diagram for SocketHandle:

Collaboration diagram for SocketHandle:

Classes
struct	SendOpts

Public Types
typedef FileHandle::ALock	ALock

Public Member Functions
	SocketHandle ()
	SocketHandle (int nfd)
void	Connect (const SocketAddress &addr)
	Create a new socket and try to connect to the given address. More...
void	Connect (const SockAddrList &addrs)
	Create a new socket and try to connect to one of the addresses in the address list. More...
void	ShutdownRead ()
	Shutdown the read end of this socket. This does NOT close the socket! Any future attempt to read from this socket will fail. More...
void	ShutdownWrite ()
	Shutdown the write end of this socket. Any future attempt to write to this socket will fail. This is how you send an end of file down the socket. More...
unsigned	Recv (void *ptr, unsigned len, bool block)
unsigned	Send (const void *ptr, unsigned len, const SendOpts &opts)
int	GetPendingError ()
	Get and clear any pending error. More...
void	SetKeepAlive (int ka)
int	GetKeepAlive ()
void	SetLingerTimeout (int seconds)
	Set the linger socket options. More...
int	GetLingerTimeout ()
void	SetReceiveBufferSize (int size)
int	GetReceiveBufferSize ()
void	SetSendBufferSize (int size)
int	GetSendBufferSize ()
void	SetReceiveTimeout (double timeout)
void	SetSendTimeout (double timeout)
double	GetReceiveTimeout ()
double	GetSendTimeout ()
void	SetNoDelay (bool nodelay)
bool	GetNoDelay ()
int	Poll (double timeout)
bool	Readable (bool r)
	Set that the file is currently readable or not. More...
bool	Readable () const
	Gives the current readability status of the file. More...
bool	Writeable (bool w)
	Set that this file is currently writeable or not. More...
bool	Writeable () const
	Gives the current writability status of the file. More...
int	FD () const
int	FD (int filed)
	Set the current file descriptor. More...
bool	Eof () const
bool	Eof (bool e)
	Set/reset the end of file condition. More...
bool	Good () const
	Convenience method for testing if the file this FileHandle has is open and not at end of file. More...
bool	Closed () const
void	SetBlocking (bool blocking)
	Manipulate how the current file handles blocking. More...
bool	IsBlocking () const
	Test if the current file is in blocking or non blocking mode. More...
void	Reset ()
	Clear all internal state including the file descriptor! WARNING does not close the file! More...
void	Close ()
	Close the file and reset the internal state. More...
unsigned	Read (void *ptr, unsigned len)
	Read data from the file descriptor. More...
unsigned	Readv (const iovec *iov, int iovcnt)
	scatter gather io version of Read More...
unsigned	Write (const void *ptr, unsigned len)
	Write data to the file descriptor. More...
unsigned	Writev (const iovec *iov, int iovcnt)
	scatter gather io version of Write More...
void	Flush ()
	Tell the OS to flush any buffers it has. May not be supported for all file types. More...

Static Public Member Functions
static void	CreatePair (SocketHandle &sock1, SocketHandle &sock2)
	Create a socket pair. More...
static void	CreatePair (int fd[2])
	Convenience function that returns actual file descriptors. More...
static int	Poll (IteratorRef< FileHandle * > begin, IteratorRef< FileHandle * > end, double timeout)
	poll a list of FileHandles for any activity and call the appropriate On method. More...
static void	SetBlocking (int fd, bool blocking)
	a convenience method that allows one to set the same blocking parameters for a file descriptor without setting it inside a FileHandle. More...
static bool	IsBlocking (int fd)
	Test the given file descriptor if it is in blocking mode. More...

Protected Member Functions
virtual void	OnReadable ()
	Called by Poll when it detects that the file is readable. More...
virtual void	OnWriteable ()
	Called by Poll when it detects that the file is writeable. More...

Protected Attributes
PthreadMutex	file_lock
int	fd
bool	readable
bool	writeable
bool	eof

Private Member Functions
bool	Connect (const SocketAddress &addr, int &error)

Detailed Description

A FileHandle customized with some socket specific functionality and functions.

Definition at line 34 of file SocketHandle.h.

Member Typedef Documentation

typedef FileHandle::ALock SocketHandle::ALock

Definition at line 36 of file SocketHandle.h.

Constructor & Destructor Documentation

SocketHandle::SocketHandle ( )

inline

Definition at line 38 of file SocketHandle.h.

{}

SocketHandle::SocketHandle ( int  nfd )

inline

Definition at line 39 of file SocketHandle.h.

: FileHandle(nfd) {}

Member Function Documentation

void FileHandle::Close ( )

inherited

Close the file and reset the internal state.

Definition at line 146 of file FileHandle.cc.

References FileHandle::eof, FileHandle::fd, FileHandle::file_lock, FileHandle::readable, and FileHandle::writeable.

Referenced by CPN::ConnectionServer::Close(), CPN::RemoteContext::EntryPoint(), CPN::RemoteQueue::HandleError(), CPN::RemoteQueue::InternalCheckStatus(), and CPN::RemoteContextDaemon::Terminate().

                       {
    ALock al(file_lock);
    if (fd != -1) {
        if (close(fd) != 0) {
            throw ErrnoException();
        }
        fd = -1;
    }
    readable = false;
    writeable = false;
    eof = false;
}

Here is the caller graph for this function:

bool FileHandle::Closed ( ) const

inlineinherited

Returns

false if this FileHandle has an open file

Definition at line 128 of file FileHandle.h.

References FileHandle::fd, and FileHandle::file_lock.

Referenced by Connect(), CPN::ConnectionServer::ConnectReader(), CPN::ConnectionServer::ConnectWriter(), CPN::RemoteQueue::FileThreadEntryPoint(), CPN::RemoteQueue::InternalCheckStatus(), CPN::RemoteQueue::LogState(), CPN::ConnectionServer::LogState(), CPN::RemoteContextDaemon::Run(), CPN::RemoteContextDaemon::Client::Send(), and CPN::RemoteContext::SendMessage().

{ ALock al(file_lock); return fd == -1; }

Here is the caller graph for this function:

void SocketHandle::Connect

(

const SocketAddress &

addr

)

Create a new socket and try to connect to the given address.

Parameters

addr	the address to connect to

Definition at line 48 of file SocketHandle.cc.

Referenced by Connect(), CPN::ConnectionServer::ConnectWriter(), and CPN::RemoteContext::RemoteContext().

                                                    {
    int error = 0;
    if (!Connect(addr, error)) { throw ErrnoException(error); }
}

Here is the caller graph for this function:

void SocketHandle::Connect

(

const SockAddrList &

addrs

)

Create a new socket and try to connect to one of the addresses in the address list.

Parameters

addrs

the addresses to try to connect to

Definition at line 53 of file SocketHandle.cc.

References Connect().

                                                    {
    int error = 0;
    bool success = false;
    for (SockAddrList::const_iterator itr = addrs.begin();
            itr != addrs.end(); ++itr) {
        success = Connect(*itr, error);
        if (success) break;
    }
    if (!success) throw ErrnoException(error);
}

Here is the call graph for this function:

bool SocketHandle::Connect ( const SocketAddress &  addr, int &  error  )

private

Definition at line 64 of file SocketHandle.cc.

References ASSERT, FileHandle::Closed(), SocketAddress::Family(), FileHandle::FD(), SocketAddress::GetAddr(), and SocketAddress::GetLen().

                                                                {
    ASSERT(Closed(), "Already connected!");
    int nfd = socket(addr.Family(), SOCK_STREAM, 0);
    if (nfd < 0) {
        error = errno;
        return false;
    }
    SocketAddress address = addr;
    bool loop = true;
    while (loop) {
        if (connect(nfd, address.GetAddr(), address.GetLen()) < 0) {
            error = errno;
            switch (error) {
            case EINTR:
            case EAGAIN: // not enough resources
                break;
            case EINPROGRESS: // non blocking and connection not completed yet
                // may want to change things to let non blocking connect.
            case EALREADY: // previous attempt has not completed
            case EACCES:
            case EPERM:
            case EADDRINUSE:
            case EAFNOSUPPORT:
            case EBADF:
            case ECONNREFUSED:
            case EFAULT:
            case EISCONN:
            case ENETUNREACH:
            case ENOTSOCK:
            case ETIMEDOUT:
            default:
                close(nfd);
                nfd = -1;
                return false;
            }
        } else {
           loop = false;
        }
    }
    FD(nfd);
    return true;
}

Here is the call graph for this function:

void SocketHandle::CreatePair ( SocketHandle &  sock1, SocketHandle &  sock2  )

static

Create a socket pair.

Parameters

sock1	SocketHandle to fill with one of the created file descriptors
sock2	SocketHandle to fill with one of the created file descriptors

Definition at line 33 of file SocketHandle.cc.

References ASSERT, and FileHandle::FD().

                                                                      {
    ASSERT(sock1.FD() == -1, "sock1 already connected");
    ASSERT(sock2.FD() == -1, "sock2 already connected");
    int pair[2];
    CreatePair(pair);
    sock1.FD(pair[0]);
    sock2.FD(pair[1]);
}

Here is the call graph for this function:

void SocketHandle::CreatePair ( int  fd[2] )

static

Convenience function that returns actual file descriptors.

Definition at line 42 of file SocketHandle.cc.

                                       {
    if (socketpair(AF_UNIX, SOCK_STREAM, 0, fd) < 0) {
        throw ErrnoException(errno);
    }
}

bool FileHandle::Eof ( ) const

inlineinherited

Returns

the current end of file condition

Definition at line 115 of file FileHandle.h.

References FileHandle::eof, and FileHandle::file_lock.

Referenced by CPN::RemoteQueue::EnqueuePacket(), CPN::RemoteContext::EntryPoint(), CPN::RemoteQueue::InternalCheckStatus(), CPN::RemoteContextDaemon::Client::Read(), and CPN::RemoteQueue::Read().

{ ALock al(file_lock); return eof; }

Here is the caller graph for this function:

bool FileHandle::Eof ( bool  e )

inlineinherited

Set/reset the end of file condition.

Parameters

e	the new end of file condition

Returns

the new end of file condition

Definition at line 120 of file FileHandle.h.

References FileHandle::eof, and FileHandle::file_lock.

{ ALock al(file_lock); return eof = e; }

int FileHandle::FD ( ) const

inlineinherited

Returns

the current set file descriptor

Definition at line 106 of file FileHandle.h.

References FileHandle::fd, and FileHandle::file_lock.

Referenced by ServerSocketHandle::Accept(), CPN::RemoteContextDaemon::Client::Client(), Connect(), CPN::ConnectionServer::ConnectWriter(), CreatePair(), CPN::RemoteQueue::FileThreadEntryPoint(), FileHandle::Flush(), CPN::ConnectionServer::GetAddress(), GetKeepAlive(), GetLingerTimeout(), GetNoDelay(), GetPendingError(), GetReceiveBufferSize(), GetReceiveTimeout(), GetSendBufferSize(), GetSendTimeout(), FileHandle::IsBlocking(), ServerSocketHandle::Listen(), FileHandle::Poll(), CPN::RemoteContextDaemon::Run(), FileHandle::SetBlocking(), SetKeepAlive(), SetLingerTimeout(), SetNoDelay(), SetReceiveBufferSize(), SetReceiveTimeout(), SetSendBufferSize(), SetSendTimeout(), ShutdownRead(), ShutdownWrite(), and WakeupHandle::WakeupHandle().

{ ALock al(file_lock); return fd; }

Here is the caller graph for this function:

int FileHandle::FD ( int  filed )

inlineinherited

Set the current file descriptor.

Parameters

filed

the new file descriptor

Returns

the new file descriptor

Definition at line 111 of file FileHandle.h.

References FileHandle::fd, and FileHandle::file_lock.

{ ALock al(file_lock); return fd = filed; }

void FileHandle::Flush ( )

inherited

Tell the OS to flush any buffers it has. May not be supported for all file types.

Definition at line 293 of file FileHandle.cc.

References FileHandle::FD().

                       {
    if (fsync(FD()) != 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

int SocketHandle::GetKeepAlive

(

)

Definition at line 219 of file SocketHandle.cc.

References FileHandle::FD().

                               {
    int ka;
    socklen_t len = sizeof(ka);
    if (getsockopt(FD(), SOL_SOCKET, SO_KEEPALIVE, &ka, &len) < 0) {
        throw ErrnoException();
    }
    return ka;
}

Here is the call graph for this function:

int SocketHandle::GetLingerTimeout

(

)

Returns

number of seconds socket will linger, negative means off

Definition at line 239 of file SocketHandle.cc.

References FileHandle::FD().

                                   {
    linger l = {0};
    socklen_t len = sizeof(l);
    if (getsockopt(FD(), SOL_SOCKET, SO_LINGER, &l, &len) < 0) {
        throw ErrnoException();
    }
    if (l.l_onoff) {
        return -1;
    } else {
        return l.l_linger;
    }
}

Here is the call graph for this function:

bool SocketHandle::GetNoDelay

(

)

Definition at line 326 of file SocketHandle.cc.

References FileHandle::FD().

                              {
    int flag = 0;
    socklen_t len = sizeof(flag);
    if (getsockopt(FD(), IPPROTO_TCP, TCP_NODELAY, &flag, &len) < 0) {
        throw ErrnoException();
    }
    return flag == 0 ? false : true;
}

Here is the call graph for this function:

int SocketHandle::GetPendingError

(

)

Get and clear any pending error.

Returns

the pending error or 0 if none

Definition at line 204 of file SocketHandle.cc.

References FileHandle::FD().

                                  {
    int err = 0;
    socklen_t len = sizeof(err);
    if (getsockopt(FD(), SOL_SOCKET, SO_ERROR, &err, &len) < 0) {
        throw ErrnoException();
    }
    return err;
}

Here is the call graph for this function:

int SocketHandle::GetReceiveBufferSize

(

)

Definition at line 258 of file SocketHandle.cc.

References FileHandle::FD().

                                       {
    int size;
    socklen_t len = sizeof(size);
    if (getsockopt(FD(), SOL_SOCKET, SO_RCVBUF, &size, &len) < 0) {
        throw ErrnoException();
    }
    return size;
}

Here is the call graph for this function:

double SocketHandle::GetReceiveTimeout

(

)

Definition at line 301 of file SocketHandle.cc.

References FileHandle::FD().

                                       {
    timeval tv = {0};
    socklen_t len = sizeof(tv);
    if (getsockopt(FD(), SOL_SOCKET, SO_RCVTIMEO, &tv, &len) < 0) {
        throw ErrnoException();
    }
    return ((double)tv.tv_sec) + (((double)tv.tv_usec)*1e-6);
}

Here is the call graph for this function:

int SocketHandle::GetSendBufferSize

(

)

Definition at line 273 of file SocketHandle.cc.

References FileHandle::FD().

                                    {
    int size;
    socklen_t len = sizeof(size);
    if (getsockopt(FD(), SOL_SOCKET, SO_SNDBUF, &size, &len) < 0) {
        throw ErrnoException();
    }
    return size;
}

Here is the call graph for this function:

double SocketHandle::GetSendTimeout

(

)

Definition at line 310 of file SocketHandle.cc.

References FileHandle::FD().

                                    {
    timeval tv = {0};
    socklen_t len = sizeof(tv);
    if (getsockopt(FD(), SOL_SOCKET, SO_SNDTIMEO, &tv, &len) < 0) {
        throw ErrnoException();
    }
    return ((double)tv.tv_sec) + (((double)tv.tv_usec)*1e-6);
}

Here is the call graph for this function:

bool FileHandle::Good ( ) const

inlineinherited

Convenience method for testing if the file this FileHandle has is open and not at end of file.

Returns

true if open and not at end of file otherwise false

Definition at line 125 of file FileHandle.h.

References FileHandle::eof, FileHandle::fd, and FileHandle::file_lock.

Referenced by CPN::RemoteContext::EntryPoint(), and CPN::RemoteContextDaemon::Client::Read().

{ ALock al(file_lock); return !(eof || fd == -1); }

Here is the caller graph for this function:

bool FileHandle::IsBlocking ( ) const

inherited

Test if the current file is in blocking or non blocking mode.

Returns

true if blocking or false if non blocking

Definition at line 128 of file FileHandle.cc.

References FileHandle::FD().

                                  {
    return IsBlocking(FD());
}

Here is the call graph for this function:

bool FileHandle::IsBlocking ( int  fd )

staticinherited

Test the given file descriptor if it is in blocking mode.

Parameters

fd	the file descriptor to test

Returns

true if blocking or false if non blocking

Definition at line 132 of file FileHandle.cc.

                                  {
    int flags = fcntl(fd, F_GETFL, 0);
    if (-1 == flags) { throw ErrnoException(); }
    return !(flags & O_NONBLOCK);
}

virtual void FileHandle::OnReadable ( )

inlineprotectedvirtualinherited

Called by Poll when it detects that the file is readable.

Reimplemented in WakeupHandle.

Definition at line 210 of file FileHandle.h.

References FileHandle::Readable().

Referenced by FileHandle::Poll().

{ Readable(true); }

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void FileHandle::OnWriteable ( )

inlineprotectedvirtualinherited

Called by Poll when it detects that the file is writeable.

Definition at line 212 of file FileHandle.h.

References FileHandle::Writeable().

Referenced by FileHandle::Poll().

{ Writeable(true); }

Here is the call graph for this function:

Here is the caller graph for this function:

int FileHandle::Poll ( IteratorRef< FileHandle * >  begin, IteratorRef< FileHandle * >  end, double  timeout  )

staticinherited

poll a list of FileHandles for any activity and call the appropriate On method.

Definition at line 34 of file FileHandle.cc.

References FileHandle::FD(), FileHandle::fd, FileHandle::OnReadable(), FileHandle::OnWriteable(), FileHandle::Readable(), and FileHandle::Writeable().

Referenced by CPN::RemoteContext::EntryPoint(), CPN::RemoteQueue::FileThreadEntryPoint(), CPN::ConnectionServer::Poll(), FileHandle::Poll(), and CPN::RemoteContextDaemon::Run().

                                                                                                 {
    fd_set rfd;
    fd_set wfd;
    FD_ZERO(&rfd);
    FD_ZERO(&wfd);
    int maxfd = 0;
    IteratorRef<FileHandle*> itr = begin;
    while (itr != end) {
        FileHandle *han = *itr;
        int fd = han->FD();
        if (fd < 0) {
            return -1;
        } else {
            bool set = false;
            if (!han->Readable()) {
                FD_SET(fd, &rfd);
                set = true;
            }
            if (!han->Writeable()) {
                FD_SET(fd, &wfd);
                set = true;
            }
            if (set) { maxfd = std::max(maxfd, fd); }
        }
        ++itr;
    }
    timeval tv;
    timeval *ptv = 0;
    if (timeout >= 0) {
        tv.tv_sec = (int)timeout;
        tv.tv_usec = (int)((timeout - tv.tv_sec) * 1e6);
        ptv = &tv;
    }
    int ret = select(maxfd + 1, &rfd, &wfd, 0, ptv);
    if (ret < 0) {
        if (errno == EINTR) {
            return 0;
        }
        throw ErrnoException();
    }
    itr = begin;
    while (itr != end) {
        FileHandle *han = *itr;
        int fd = han->FD();
        if (fd >= 0) {
            if (FD_ISSET(fd, &rfd)) {
                han->OnReadable();
            }
            if (FD_ISSET(fd, &wfd)) {
                han->OnWriteable();
            }
        }
        ++itr;
    }
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

int FileHandle::Poll ( double  timeout )

inherited

Poll the current file descriptor for activity specified by the current readable or writeable status, if false poll that value, and call one of OnWriteable or OnReadable whos default action is to set Readable or Writeable to true.

Parameters

timeout

-1 to wait forever for activity 0 to poll and return immediately or a time to wait in seconds.

Returns

zero if timed out, positive if an event occurred or negative if an error occurred.

Definition at line 106 of file FileHandle.cc.

References FileHandle::Poll().

                                   {
    FileHandle *fh = this;
    return Poll(&fh, &fh + 1, timeout);
}

Here is the call graph for this function:

unsigned FileHandle::Read ( void *  ptr, unsigned  len  )

inherited

Read data from the file descriptor.

Will set the end of file condition if read detects end of file.

Note

All the read functions will set readable to false if they read less than the requested amount or we are non blocking and a would block condition happened.

Parameters

ptr	pointer to write data to
len	the maximum number of bytes to write to ptr

Returns

0 if no bytes read (check Eof) or the number of bytes read

Definition at line 159 of file FileHandle.cc.

References FileHandle::eof, FileHandle::fd, FileHandle::file_lock, FileHandle::Readable(), and FileHandle::readable.

Referenced by CPN::RemoteQueue::D4RTagPacket(), and WakeupHandle::Read().

                                                 {
    int filed;
    {
        ALock al(file_lock);
        if (eof || fd == -1) { return 0; }
        filed = fd;
    }
    unsigned bytesread = 0;
    int num = read(filed, ptr, len);
    if (num < 0) {
        int error = errno;
        switch (error) {
        case EAGAIN:
            Readable(false);
        case EINTR:
        case ENOMEM:
            break;
        default:
            throw ErrnoException(error);
        }
    } else if (num == 0 && len != 0) {
        ALock al(file_lock);
        eof = true;
        readable = false;
    } else {
        if (unsigned(num) < len) { Readable(false); }
        bytesread = num;
    }
    return bytesread;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool FileHandle::Readable ( bool  r )

inlineinherited

Set that the file is currently readable or not.

Parameters

r	true or false

Returns

the new readable status

Definition at line 86 of file FileHandle.h.

References FileHandle::file_lock, and FileHandle::readable.

Referenced by CPN::RemoteContext::EntryPoint(), FileHandle::Poll(), CPN::ConnectionServer::Poll(), and CPN::RemoteQueue::Read().

{ ALock al(file_lock); return readable = r; }

Here is the caller graph for this function:

bool FileHandle::Readable ( ) const

inlineinherited

Gives the current readability status of the file.

Returns

true if it is known that a read will not block

Definition at line 91 of file FileHandle.h.

References FileHandle::file_lock, and FileHandle::readable.

Referenced by ServerSocketHandle::Accept(), CPN::RemoteContextDaemon::Client::Client(), FileHandle::OnReadable(), CPN::RemoteContextDaemon::Read(), FileHandle::Read(), FileHandle::Readv(), Recv(), CPN::RemoteContextDaemon::Run(), and WakeupHandle::WakeupHandle().

{ ALock al(file_lock); return readable; }

Here is the caller graph for this function:

unsigned FileHandle::Readv ( const iovec *  iov, int  iovcnt  )

inherited

scatter gather io version of Read

Returns

see Read

Definition at line 190 of file FileHandle.cc.

References FileHandle::eof, FileHandle::fd, FileHandle::file_lock, FileHandle::Readable(), and FileHandle::readable.

Referenced by CPN::RemoteQueue::EnqueuePacket().

                                                       {
    int filed;
    {
        ALock al(file_lock);
        if (eof || fd == -1) { return 0; }
        filed = fd;
    }
    unsigned len = 0;
    for (int i = 0; i < iovcnt; ++i) {
        len += iov[i].iov_len;
    }
    unsigned bytesread = 0;
    int num = readv(filed, iov, iovcnt);
    if (num < 0) {
        int error = errno;
        switch (error) {
        case EAGAIN:
            Readable(false);
        case EINTR:
        case ENOMEM:
            break;
        default:
            throw ErrnoException(error);
        }
    } else if (num == 0 && len != 0) {
        ALock al(file_lock);
        eof = true;
        readable = false;
    } else {
        if (unsigned(num) < len) { Readable(false); }
        bytesread = num;
    }
    return bytesread;
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned SocketHandle::Recv	(	void *	ptr,
		unsigned	len,
		bool	block
	)

Parameters

ptr	pointer to memory to place read data
len	maximum number of bytes to read
block	If block true then wait for buffer to be full if block false don't wait for anything

Returns

number of bytes read

Definition at line 119 of file SocketHandle.cc.

References FileHandle::eof, FileHandle::fd, FileHandle::file_lock, FileHandle::Readable(), and FileHandle::readable.

Referenced by CPN::RemoteContext::EntryPoint(), and CPN::RemoteQueue::Read().

                                                               {
    int filed;
    {
        ALock al(file_lock);
        if (eof || fd == -1) { return 0; }
        filed = fd;
    }
    int flags = 0;
    if (block) {
        flags |= MSG_WAITALL;
    } else {
        flags |= MSG_DONTWAIT;
    }
    unsigned bytesread = 0;
    int num = recv(filed, ptr, len, flags);
    if (num > 0) {
        if (unsigned(num) < len) { Readable(false); }
        bytesread = num;
    } else if (num == 0 && len != 0) {
        ALock al(file_lock);
        eof = true;
        readable = false;
    } else if (num < 0) {
        int error = errno;
        switch (error) {
        case EAGAIN: // Ether non blocking or timed out
            Readable(false);
        case EINTR: // Interrupted by an interrupt
        case ENOMEM:
            // report nothing received
            break;
        default:
            throw ErrnoException(error);
        }
    }
    return bytesread;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void FileHandle::Reset ( )

inherited

Clear all internal state including the file descriptor! WARNING does not close the file!

Definition at line 138 of file FileHandle.cc.

References FileHandle::eof, FileHandle::fd, FileHandle::file_lock, FileHandle::readable, and FileHandle::writeable.

Referenced by CPN::ConnectionServer::ConnectWriter(), CPN::RemoteQueue::FileThreadEntryPoint(), and FileHandle::~FileHandle().

                       {
    ALock al(file_lock);
    readable = false;
    writeable = false;
    eof = false;
    fd = -1;
}

Here is the caller graph for this function:

unsigned SocketHandle::Send	(	const void *	ptr,
		unsigned	len,
		const SendOpts &	opts
	)

Parameters

ptr	pointer to bytes to write
len	number of bytes to write
opts	an option object (note that a blank option object this function is exactly the same as Write)

Returns

number of bytes written

Definition at line 177 of file SocketHandle.cc.

References FileHandle::fd, FileHandle::file_lock, SocketHandle::SendOpts::flags, and FileHandle::Writeable().

                                                                               {
    int filed;
    {
        ALock al(file_lock);
        if (fd == -1) { return 0; }
        filed = fd;
    }
    unsigned written = 0;
    int num = send(filed, ptr, len, opts.flags);
    if (num < 0) {
        int error = errno;
        switch (error) {
        case EAGAIN:
            Writeable(false);
        case EINTR:
        case ENOMEM:
            break;
        default:
            throw ErrnoException(error);
        }
    } else {
        if (unsigned(num) < len) { Writeable(false); }
        written = num;
    }
    return written;
}

Here is the call graph for this function:

void FileHandle::SetBlocking ( bool  blocking )

inherited

Manipulate how the current file handles blocking.

Parameters

blocking

true to set to blocking mode (default) false to set to non blocking mode.

In non blocking mode all reads and writes will not block. Use Poll to block.

Definition at line 111 of file FileHandle.cc.

References FileHandle::FD().

Referenced by WakeupHandle::WakeupHandle().

                                          {
    SetBlocking(FD(), blocking);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void FileHandle::SetBlocking ( int  fd, bool  blocking  )

staticinherited

a convenience method that allows one to set the same blocking parameters for a file descriptor without setting it inside a FileHandle.

Parameters

fd	the file descriptor
blocking	true or false see SetBlock

Definition at line 115 of file FileHandle.cc.

                                                  {
    int flags = fcntl(fd, F_GETFL, 0);
    if (-1 == flags) { throw ErrnoException(); }
    if (blocking) {
        flags &= ~O_NONBLOCK;
    } else {
        flags |= O_NONBLOCK;
    }
    if (fcntl(fd, F_SETFL, flags) != 0) {
        throw ErrnoException();
    }
}

void SocketHandle::SetKeepAlive

(

int

ka

)

Definition at line 213 of file SocketHandle.cc.

References FileHandle::FD().

                                      {
    if (setsockopt(FD(), SOL_SOCKET, SO_KEEPALIVE, &ka, sizeof(ka)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::SetLingerTimeout

(

int

seconds

)

Set the linger socket options.

Parameters

seconds

number of seconds to linger, negative to turn off

Definition at line 228 of file SocketHandle.cc.

References FileHandle::FD().

                                               {
    linger l = {0};
    if (seconds > 0) {
        l.l_onoff = 1;
        l.l_linger = seconds;
    }
    if (setsockopt(FD(), SOL_SOCKET, SO_LINGER, &l, sizeof(l)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::SetNoDelay

(

bool

nodelay

)

Definition at line 319 of file SocketHandle.cc.

References FileHandle::FD().

Referenced by CPN::RemoteContextDaemon::Client::Client(), CPN::RemoteQueue::FileThreadEntryPoint(), and CPN::RemoteContext::RemoteContext().

                                          {
    int flag = nodelay ? 1 : 0;
    if (setsockopt(FD(), IPPROTO_TCP, TCP_NODELAY, &flag, sizeof(flag)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SocketHandle::SetReceiveBufferSize

(

int

size

)

Definition at line 252 of file SocketHandle.cc.

References FileHandle::FD().

                                                {
    if (setsockopt(FD(), SOL_SOCKET, SO_RCVBUF, &size, sizeof(size)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::SetReceiveTimeout

(

double

timeout

)

Definition at line 283 of file SocketHandle.cc.

References FileHandle::FD().

                                                   {
    timeval tv = {0};
    tv.tv_sec = (int)timeout;
    tv.tv_usec = (int)((timeout - tv.tv_sec) * 1e6);
    if (setsockopt(FD(), SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::SetSendBufferSize

(

int

size

)

Definition at line 267 of file SocketHandle.cc.

References FileHandle::FD().

                                             {
    if (setsockopt(FD(), SOL_SOCKET, SO_SNDBUF, &size, sizeof(size)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::SetSendTimeout

(

double

timeout

)

Definition at line 292 of file SocketHandle.cc.

References FileHandle::FD().

                                                {
    timeval tv = {0};
    tv.tv_sec = (int)timeout;
    tv.tv_usec = (int)((timeout - tv.tv_sec) * 1e6);
    if (setsockopt(FD(), SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv)) < 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::ShutdownRead

(

)

Shutdown the read end of this socket. This does NOT close the socket! Any future attempt to read from this socket will fail.

Definition at line 107 of file SocketHandle.cc.

References FileHandle::FD().

                                {
    if (shutdown(FD(), SHUT_RD) != 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

void SocketHandle::ShutdownWrite

(

)

Shutdown the write end of this socket. Any future attempt to write to this socket will fail. This is how you send an end of file down the socket.

Definition at line 113 of file SocketHandle.cc.

References FileHandle::FD().

Referenced by CPN::RemoteContext::EndWrite(), CPN::RemoteQueue::SendEndOfReadPacket(), and CPN::RemoteQueue::SendEndOfWritePacket().

                                 {
    if (shutdown(FD(), SHUT_WR) != 0) {
        throw ErrnoException();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned FileHandle::Write ( const void *  ptr, unsigned  len  )

inherited

Write data to the file descriptor.

Note

All write functions will set Writeable to false if they write less than the amount requested or if the file is in non blocking mode and the write returned would block.

Parameters

ptr	pointer to beginning of data to write
len	length of data to write

Returns

number of bytes written

Definition at line 225 of file FileHandle.cc.

References FileHandle::fd, FileHandle::file_lock, and FileHandle::Writeable().

Referenced by CPN::ConnectionServer::ConnectWriter(), CPN::RemoteContextDaemon::Client::Send(), CPN::RemoteContext::SendMessage(), and CPN::RemoteQueue::WriteBytes().

                                                        {
    int filed;
    {
        ALock al(file_lock);
        if (fd == -1) { return 0; }
        filed = fd;
    }
    unsigned written = 0;
    int num = write(filed, ptr, len);
    if (num < 0) {
        int error = errno;
        switch (error) {
        case EAGAIN: // Would block
        //case EWOULDBLOCK:
            Writeable(false);
        case EINTR: // Returned because of signal
        case ENOMEM:
        case ENOBUFS: // Buffers are full
            break;
        case EPIPE:
        case EBADF:
        case EFAULT:
        case EFBIG:
        case EINVAL:
        case EIO:
        case ENOSPC:
        default:
            throw ErrnoException(error);
        }
    } else {
        if (unsigned(num) < len) { Writeable(false); }
        written = num;
    }
    return written;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool FileHandle::Writeable ( bool  w )

inlineinherited

Set that this file is currently writeable or not.

Parameters

w	true or false

Returns

the new writeable status

Definition at line 97 of file FileHandle.h.

References FileHandle::file_lock, and FileHandle::writeable.

Referenced by FileHandle::Poll().

{ ALock al(file_lock); return writeable = w; }

Here is the caller graph for this function:

bool FileHandle::Writeable ( ) const

inlineinherited

Gives the current writability status of the file.

Returns

true if it is known that a write will not block

Definition at line 102 of file FileHandle.h.

References FileHandle::file_lock, and FileHandle::writeable.

Referenced by FileHandle::OnWriteable(), Send(), WakeupHandle::WakeupHandle(), FileHandle::Write(), and FileHandle::Writev().

{ ALock al(file_lock); return writeable; }

Here is the caller graph for this function:

unsigned FileHandle::Writev ( const iovec *  iov, int  iovcnt  )

inherited

scatter gather io version of Write

Returns

see Write

Definition at line 261 of file FileHandle.cc.

References FileHandle::fd, FileHandle::file_lock, and FileHandle::Writeable().

Referenced by CPN::RemoteQueue::WriteBytes().

                                                        {
    int filed;
    {
        ALock al(file_lock);
        if (fd == -1) { return 0; }
        filed = fd;
    }
    unsigned written = 0;
    int num = writev(filed, iov, iovcnt);
    if (num < 0) {
        int error = errno;
        switch (error) {
        case EAGAIN:
            Writeable(false);
        case EINTR:
        case ENOMEM:
        case ENOBUFS:
            break;
        default:
            throw ErrnoException(error);
        }
    } else {
        unsigned len = 0;
        for (int i = 0; i < iovcnt; ++i) {
            len += iov[i].iov_len;
        }
        if (unsigned(num) < len) { Writeable(false); }
        written = num;
    }
    return written;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bool FileHandle::eof

protectedinherited

Definition at line 217 of file FileHandle.h.

Referenced by FileHandle::Close(), FileHandle::Eof(), FileHandle::Good(), FileHandle::Read(), FileHandle::Readv(), Recv(), and FileHandle::Reset().

int FileHandle::fd

protectedinherited

Definition at line 214 of file FileHandle.h.

Referenced by FileHandle::Close(), FileHandle::Closed(), FileHandle::FD(), FileHandle::Good(), FileHandle::Poll(), FileHandle::Read(), FileHandle::Readv(), Recv(), FileHandle::Reset(), Send(), FileHandle::Write(), FileHandle::Writev(), and FileHandle::~FileHandle().

PthreadMutex FileHandle::file_lock

mutableprotectedinherited

Definition at line 213 of file FileHandle.h.

Referenced by FileHandle::Close(), FileHandle::Closed(), FileHandle::Eof(), FileHandle::FD(), FileHandle::Good(), FileHandle::Read(), FileHandle::Readable(), FileHandle::Readv(), Recv(), FileHandle::Reset(), Send(), WakeupHandle::SendWakeup(), FileHandle::Write(), FileHandle::Writeable(), and FileHandle::Writev().

bool FileHandle::readable

protectedinherited

Definition at line 215 of file FileHandle.h.

Referenced by FileHandle::Close(), FileHandle::Read(), FileHandle::Readable(), FileHandle::Readv(), Recv(), and FileHandle::Reset().

bool FileHandle::writeable

protectedinherited

Definition at line 216 of file FileHandle.h.

Referenced by FileHandle::Close(), FileHandle::Reset(), and FileHandle::Writeable().

---

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

• include/cpn/io/SocketHandle.h
• lib/io/SocketHandle.cc