ipcproto.common Namespace Reference

Data Structures
class	Arg
class	Call
class	HandleType
class	Proto

Functions
	write_cpp_header_guard_start (f)
	write_cpp_header_guard_end (f)
	write_with_wrapped_args (f, start, args, indent)
	write_decl (f, return_type, function_name, args, indent="")
	write_invocation (f, return_val, function_name, args, indent="")
	write_result_handler (f, result, cleanup="", indent="")
	write_msg_struct (f, call, ident)
	write_reply_struct (f, call, ident)
	write_msg_send (f, ret, indent)

Detailed Description

Generate code from a JSON file describing the IPC protocol.

Function Documentation

write_cpp_header_guard_end()

ipcproto.common.write_cpp_header_guard_end

(

f

)

Write the ending C in C++ header guard

write_cpp_header_guard_start()

ipcproto.common.write_cpp_header_guard_start

(

f

)

Write the starting C in C++ header guard

write_decl()

ipcproto.common.write_decl	(		f,
			return_type,
			function_name,
			args,
			indent = ""
	)

Write a function declaration/definition with wrapped arguments.

References ipcproto.common.write_with_wrapped_args().

write_invocation()

ipcproto.common.write_invocation	(		f,
			return_val,
			function_name,
			args,
			indent = ""
	)

Write a function call with saved return value and wrapped arguments.

References ipcproto.common.write_with_wrapped_args().

write_result_handler()

ipcproto.common.write_result_handler	(		f,
			result,
			cleanup = "",
			indent = ""
	)

Write a check of an xrt_result_t value and early out.

write_with_wrapped_args()

ipcproto.common.write_with_wrapped_args	(		f,
			start,
			args,
			indent
	)

Write something like a declaration or call.

Referenced by ipcproto.common.write_decl(), and ipcproto.common.write_invocation().