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

Add javadoc to Subsegment.close() method. #342

Merged
merged 1 commit into from
Jul 28, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add javadoc to Subsegment.close() method.
This method should not be used to end subsegments for segments using multiple threads as this can result in a deadlock. See #318 for details.
  • Loading branch information
Kurru committed Jul 28, 2022
commit ba7a37b399b272b2b165041aed29a4a086989d7c
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
/**
* Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.
* @return
* the string representation of the subsegment with enouogh information for it to be streamed
* the string representation of the subsegment with enough information for it to be streamed
*/
String streamSerialize();

Expand All @@ -96,10 +96,16 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
* own. Only used for debugging.
*
* @return
* the pretty string representation of the subsegment with enouogh information for it to be streamed
* the pretty string representation of the subsegment with enough information for it to be streamed
*/
String prettyStreamSerialize();

/**
* Implements the {@link AutoCloseable} interface.
*
* Warning. This method is intended to be private to the xray library and should not be used externally. Instead, use
* {@link com.amazonaws.xray.AWSXRay#endSubsegment(Subsegment)}.
*/
@Override
void close();
}