Channel Class Reference

Channel class for asynchronous communication. More...

#include <channel.h>

Classes
struct	bgnet_IDs

Public Types
enum	channel_mode { SEND, RECV }
typedef char	element_type
typedef std::valarray < element_type >	container_type
typedef char	element_type
	data transfer is byte-wise. More...
typedef std::valarray < element_type >	container_type

Public Member Functions
	Channel ()
	Channel (const int count)
	Channel (const int count, const int tag, const channel_mode mode)
virtual	~Channel ()
int	start ()
int	wait ()
void	set_thread (int, const std::valarray< int > &, const std::valarray< int > &, const std::valarray< int > &)
int	start_thread (int)
int	wait_thread (int)
element_type &	operator[] (unsigned int idx)
const element_type *	ptr ()
const element_type *	ptr (int offset)
	Channel ()
	constructor. More...
	Channel (const int count)
	constructor with buffer size (count bytes) More...
virtual	~Channel ()
	destructor More...
int	start ()
	start asynchronous communication More...
int	wait ()
	wait for completion More...
element_type &	operator[] (unsigned int idx)
	accessor to buffer More...
element_type	operator[] (unsigned int idx) const
	accessor to buffer More...
const element_type *	ptr ()
	accessor to buffer; returns pointer to the first element. More...

Static Public Member Functions
static void	increment_channel_set_id ()
	To be called before defining new set of channels for a operator. More...

Private Attributes
int	m_count
int	m_ibuf
bgnet_IDs	m_bgnet_ids
std::valarray< bgnet_IDs >	m_bgnet_ids_thread
container_type	m_buf
	buffer More...
MPI_Request	m_request
	handler to MPI persistent communication More...
MPI_Status	m_status
	handler to MPI status information More...

Static Private Attributes
static std::vector < container_type >	m_buf
static int	m_set_id = 0
	identifies set of channels. More...

Friends
class	Communicator_impl
class	ChannelSet

Detailed Description

Channel class for asynchronous communication.

Channel class defines communication channel between sender and receiver for asynchronous data transfer. It actually provides a half-channel of sender part or receiver part. This class wraps MPI persistent communication, as well as send/receive buffer.

An instance of channel class is generated through Communicator send_int() and recv_init() methods. To access the buffer, operator[] is provided as if it is an ordinary container or array.

start() method to start async data transfer, and wait() method to wait for the completion of operation. the channel instance will be re-used repeatedly for the same communication channel once it is created.

Definition at line 16 of file channel.h.

Member Typedef Documentation

typedef std::valarray<element_type> Channel::container_type

Definition at line 19 of file channel.h.

typedef std::valarray<element_type> Channel::container_type

Definition at line 54 of file channel.h.

typedef char Channel::element_type

Definition at line 18 of file channel.h.

typedef char Channel::element_type

data transfer is byte-wise.

Definition at line 53 of file channel.h.

Member Enumeration Documentation

enum Channel::channel_mode

Enumerator
SEND
RECV

Definition at line 20 of file channel.h.

Constructor & Destructor Documentation

Channel::Channel

(

)

Definition at line 89 of file channel.cpp.

Channel::Channel

(

const int

count

)

Definition at line 95 of file channel.cpp.

Channel::Channel	(	const int	count,
		const int	tag,
		const channel_mode	mode
	)

Definition at line 137 of file channel.cpp.

Channel::~Channel ( )

virtual

Definition at line 189 of file channel.cpp.

Channel::Channel

(

)

constructor.

Channel::Channel

(

const int

count

)

constructor with buffer size (count bytes)

virtual Channel::~Channel ( )

virtual

destructor

Member Function Documentation

static void Channel::increment_channel_set_id ( )

static

To be called before defining new set of channels for a operator.

element_type& Channel::operator[] ( unsigned int  idx )

inline

accessor to buffer

Definition at line 64 of file channel.h.

element_type Channel::operator[] ( unsigned int  idx ) const

inline

accessor to buffer

Definition at line 66 of file channel.h.

element_type& Channel::operator[] ( unsigned int  idx )

inline

Definition at line 69 of file channel.h.

const element_type* Channel::ptr ( )

inline

accessor to buffer; returns pointer to the first element.

Definition at line 68 of file channel.h.

const element_type* Channel::ptr ( )

inline

Definition at line 76 of file channel.h.

const element_type* Channel::ptr ( int  offset )

inline

Definition at line 81 of file channel.h.

void Channel::set_thread	(	int	Ntask,
		const std::valarray< int > &	destid,
		const std::valarray< int > &	offset,
		const std::valarray< int > &	datasize
	)

Definition at line 40 of file channel.cpp.

int Channel::start

(

)

Definition at line 196 of file channel.cpp.

int Channel::start

(

)

start asynchronous communication

int Channel::start_thread

(

int

itask

)

Definition at line 238 of file channel.cpp.

int Channel::wait

(

)

Definition at line 220 of file channel.cpp.

int Channel::wait

(

)

wait for completion

int Channel::wait_thread

(

int

itask

)

Definition at line 263 of file channel.cpp.

Friends And Related Function Documentation

friend class ChannelSet

friend

Definition at line 77 of file channel.h.

Communicator_impl

friend

Definition at line 86 of file channel.h.

Member Data Documentation

bgnet_IDs Channel::m_bgnet_ids

private

Definition at line 46 of file channel.h.

std::valarray<bgnet_IDs> Channel::m_bgnet_ids_thread

private

Definition at line 47 of file channel.h.

std::vector< Channel::container_type > Channel::m_buf

staticprivate

Definition at line 29 of file channel.h.

container_type Channel::m_buf

private

buffer

Definition at line 71 of file channel.h.

int Channel::m_count

private

Definition at line 30 of file channel.h.

int Channel::m_ibuf

private

Definition at line 31 of file channel.h.

MPI_Request Channel::m_request

private

handler to MPI persistent communication

Definition at line 73 of file channel.h.

int Channel::m_set_id = 0

staticprivate

identifies set of channels.

Definition at line 49 of file channel.h.

MPI_Status Channel::m_status

private

handler to MPI status information

Definition at line 74 of file channel.h.

---

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

• /work/sueda-2/code/bridge-code/bridge-1.2.2/src/Communicator/BGNET/channel.h
• /work/sueda-2/code/bridge-code/bridge-1.2.2/src/Communicator/MPI/channel.h
• /work/sueda-2/code/bridge-code/bridge-1.2.2/src/Communicator/BGNET/channel.cpp
• /work/sueda-2/code/bridge-code/bridge-1.2.2/src/Communicator/MPI/channel.cpp