Bug 1138199 - MPR contains C++ Messaging Exceptions Class Hierarchy but not the other languages (python, c#)
Summary: MPR contains C++ Messaging Exceptions Class Hierarchy but not the other langu...
Keywords:
Status: ASSIGNED
Alias: None
Product: Red Hat Enterprise MRG
Classification: Red Hat
Component: Messaging_Programming_Reference
Version: Development
Hardware: Unspecified
OS: Unspecified
low
medium
Target Milestone: Next Version
: ---
Assignee: Nobody
QA Contact: Messaging QE
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-09-04 09:15 UTC by Frantisek Reznicek
Modified: 2023-06-23 14:13 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
MPR: Not going to fit into 3.2 schedule, but will keep it active as it would be good to fix if gaps in other schedules exist.
Last Closed:
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Frantisek Reznicek 2014-09-04 09:15:17 UTC
Description of problem:

At the moment MPR contains C++ Messaging Exceptions Class Hierarchy but not the other languages.

There are two possible ways:
 * remove c++ wording and c++ namespace decorators and make 10.1. Handling Exceptions language independent
or 
 * change C++ Messaging Exceptions Class Hierarchy to 
   C++ and dependent Messaging Exceptions Class Hierarchy and add Separate python Messaging Exceptions Class Hierarchy

The goal of this defect is to unify Exception reference to support more than languages than just c++ (c# and python).


Version-Release number of selected component (if applicable):
Vienna MPR

How reproducible:
100%

Steps to Reproduce:
1. Search for python Exception reference 
   none

Actual results:
  Exception reference specific to C++, missing c#, python ones

Expected results:
  Unified Exception reference covering at least c++, c# and python

Additional info:

Comment 1 Jared MORGAN 2015-01-13 04:26:55 UTC
(In reply to Frantisek Reznicek from comment #0)
> Description of problem:
> 
> At the moment MPR contains C++ Messaging Exceptions Class Hierarchy but not
> the other languages.
> 
> There are two possible ways:
>  * remove c++ wording and c++ namespace decorators and make 10.1. Handling
> Exceptions language independent
> or 
>  * change C++ Messaging Exceptions Class Hierarchy to 
>    C++ and dependent Messaging Exceptions Class Hierarchy and add Separate
> python Messaging Exceptions Class Hierarchy
> 
> The goal of this defect is to unify Exception reference to support more than
> languages than just c++ (c# and python).
> 
> 
> Version-Release number of selected component (if applicable):
> Vienna MPR
> 
> How reproducible:
> 100%
> 
> Steps to Reproduce:
> 1. Search for python Exception reference 
>    none
> 
> Actual results:
>   Exception reference specific to C++, missing c#, python ones
> 
> Expected results:
>   Unified Exception reference covering at least c++, c# and python

Hi Frantisek

What would you prefer happen for this issue? That the Exception reference for C++, c# and python be documented in full? If yes, how would I go about resolving this issue satisfactorally.

Is there good info existing for c# and python examples for the Exception reference? I noted that there is a SVN repo mentioned in http://docbuilder.usersys.redhat.com/19948/#C_Messaging_Exceptions_Reference. Would that be a place that I could get the c# and python exception references. If so, what pattern in this file should I be looking out for?

If we made http://docbuilder.usersys.redhat.com/19948/#sect-Handling_Exceptions language independent as suggested in one of the options, would that prevent customers becoming confused?

Comment 4 Frantisek Reznicek 2015-03-16 09:01:30 UTC
> What would you prefer happen for this issue? That the Exception reference
> for C++, c# and python be documented in full? If yes, how would I go about
> resolving this issue satisfactorally.

I'd prefer to have common chapter with all exceptions for all languages which allows to see equivalent exceptions in different languages. This is of course much harder than having separate sections for individual languages.

In theory the section talks about the same library qpid messaging so there should be approx. same exceptions in all languages also .NET managed c# library is made on top of unmanaged c++ one. With python it is different, that's why there will be exceptions.

This defect tracks that c# and python exceptions are not mentioned by documentation, i.e. if all c++, c# and python exceptions are mentioned then issue is solved.

> 
> Is there good info existing for c# and python examples for the Exception
> reference? I noted that there is a SVN repo mentioned in
> http://docbuilder.usersys.redhat.com/19948/#C_Messaging_Exceptions_Reference.
> Would that be a place that I could get the c# and python exception
> references. If so, what pattern in this file should I be looking out for?
> 
> If we made
> http://docbuilder.usersys.redhat.com/19948/#sect-Handling_Exceptions
> language independent as suggested in one of the options, would that prevent
> customers becoming confused?

The optimal chapter structure should be very similar to the current one:

N. Handling Exceptions
N.1 Messaging Exceptions References
  + add links to c++ c# and python exception references
N.2 Connection Exceptions
N.3 Session Exceptions
N.4 Sender Exceptions
N.5 Receiver Exceptions
N.6 Other Exceptions

I think 'N.6 Other Exceptions' might be the one where we can see the smallest overlap among languages so there might be separate sub-chapters for individual languages (if needed).


Python and c# references are probably best to get from sources:
 * C# exceptions there are unfortunately not in single file
   https://qpid.apache.org/releases/qpid-0.30/messaging-api/dotnet/api/index.html
   Majority of exceptions are passed to c++ layer
   List of exceptions can be obtained (grep  'Exception' */*.cs | grep public)
 * Python exceptions can be obtained from
   https://qpid.apache.org/releases/qpid-0.30/messaging-api/python/api/index.html
   or eventually by typing 'pydoc qpid.messaging.exceptions' when python-qpid is installed

Comment 8 Scott Mumford 2015-09-03 00:45:57 UTC
Taking ownership of MRG-M bugs


Note You need to log in before you can comment on or make changes to this bug.