Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[protocol specification] kXR_stat#fhandle is undocumented #839

Closed
paulmillar opened this issue Oct 10, 2018 · 4 comments
Closed

[protocol specification] kXR_stat#fhandle is undocumented #839

paulmillar opened this issue Oct 10, 2018 · 4 comments
Assignees
Labels
Documentation Issue Missing or incorrect documentation

Comments

@paulmillar
Copy link
Contributor

The documentation for the kXR_stat request is missing any description of the fhandle request argument.

The most important parts are:

  • is fhandle the handle returned from an kXR_open request, that has not yet been closed?
  • when should the server react to the path fields (plen / path) and when it should react to fhandle?
  • how should the server react if both are supplied?
@abh3
Copy link
Member

abh3 commented Oct 10, 2018 via email

@paulmillar
Copy link
Contributor Author

Hi Andy,

Thanks for the comments, although I think you misunderstood the focus of this issue.

I'm referring to the PROTOCOL DOCUMENTATION, not about any client implementation or server implementation (i.e., this is NOT about code).

In v2.9.9 (linked to above) the PROTOCOL DOCUMENTATION does not describe what fhandle means, when describing the kXR_stat request. The field appears in the request structure, but is not described in the Where: section.

The same problem exists in the v3.1.0 and v4.0.0 of the PROTOCOL DOCUMENTATION: none of these versions describe what fhandle means for the kXR_stat request.

From reading the xrootd source code, I believe fhandle is an opened file handle (as returned by kXR_open). Also, if the client makes an kXR_stat request and specifies the plen value of zero then the server should use the fhandle value; otherwise, the path information (plen / path) is used.

It would be helpful if these details where checked, and the PROTOCOL DOCUMENTATION is updated to record this information, if they are correct.

Cheers,

Paul.

@xrootd-dev
Copy link

xrootd-dev commented Oct 10, 2018 via email

@abh3 abh3 self-assigned this Feb 22, 2019
@abh3 abh3 added Documentation Issue Missing or incorrect documentation and removed bug (non-critical) labels Feb 18, 2020
@abh3
Copy link
Member

abh3 commented Mar 31, 2020

This has been fixed in the R5 documentation set.

@abh3 abh3 closed this as completed Mar 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue Missing or incorrect documentation
Projects
None yet
Development

No branches or pull requests

3 participants