summaryrefslogtreecommitdiffstats
path: root/yt/cpp/mapreduce/interface/distributed_session.h
blob: 6b931fac2c4f3dfe7a8f8e54b912e951e4b2ff59 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
#pragma once

///
/// @file yt/cpp/mapreduce/interface/distributed_session.h
///
/// Header containing interface for Distributed API session objects.

#include "fwd.h"

#include <yt/cpp/mapreduce/interface/common.h>

#include <library/cpp/yt/misc/strong_typedef.h>

#include <util/datetime/base.h>

namespace NYT {

////////////////////////////////////////////////////////////////////////////////

/// @brief Distributed write table session object.
///
/// Holds server representation of distributed session.
/// Created by NYT::IClient::StartDistributedWriteTableSession.
YT_DEFINE_STRONG_TYPEDEF(TDistributedWriteTableSession, TNode);

/// @brief Cookie object for participant of distributed write table session.
///
/// Holds server representation of distributed write table cookie.
/// Created by NYT::IClient::StartDistributedWriteTableSession.
YT_DEFINE_STRONG_TYPEDEF(TDistributedWriteTableCookie, TNode);

/// @brief Fragment write result produced by NYT::ITableFragmentWriter.
///
/// Holds server representation of distributed table write fragment result.
YT_DEFINE_STRONG_TYPEDEF(TWriteTableFragmentResult, TNode);

////////////////////////////////////////////////////////////////////////////////

/// @brief Distributed write file session object.
///
/// Holds server representation of distributed session.
/// Created by NYT::IClient::StartDistributedWriteFileSession.
YT_DEFINE_STRONG_TYPEDEF(TDistributedWriteFileSession, TNode);

/// @brief Cookie object for participant of distributed write file session.
///
/// Holds server representation of distributed write file cookie.
/// Created by NYT::IClient::StartDistributedWriteFileSession.
YT_DEFINE_STRONG_TYPEDEF(TDistributedWriteFileCookie, TNode);

/// @brief Fragment write result produced by NYT::IFileFragmentWriter.
///
/// Holds server representation of distributed file write fragment result.
YT_DEFINE_STRONG_TYPEDEF(TWriteFileFragmentResult, TNode);

////////////////////////////////////////////////////////////////////////////////

struct TDistributedWriteTableSessionWithCookies
{
    using TSelf = TDistributedWriteTableSessionWithCookies;

    FLUENT_FIELD(TDistributedWriteTableSession, Session);

    FLUENT_FIELD(TVector<TDistributedWriteTableCookie>, Cookies);
};

struct TStartDistributedWriteTableOptions
{
    /// @cond Doxygen_Suppress
    using TSelf = TStartDistributedWriteTableOptions;
    /// @endcond

    ///
    /// @brief How long session lives after last ping.
    ///
    /// If server doesn't receive any pings for session transaction for this time
    /// session will be aborted. By default timeout is 15 seconds.
    FLUENT_FIELD_OPTION(TDuration, SessionTimeout);
};

struct TPingDistributedWriteTableOptions
{
    using TSelf = TPingDistributedWriteTableOptions;
};

struct TFinishDistributedWriteTableOptions
{
    using TSelf = TFinishDistributedWriteTableOptions;
};

////////////////////////////////////////////////////////////////////////////////

struct TDistributedWriteFileSessionWithCookies
{
    using TSelf = TDistributedWriteFileSessionWithCookies;

    FLUENT_FIELD(TDistributedWriteFileSession, Session);

    FLUENT_FIELD(TVector<TDistributedWriteFileCookie>, Cookies);
};

struct TStartDistributedWriteFileOptions
{
    /// @cond Doxygen_Suppress
    using TSelf = TStartDistributedWriteFileOptions;
    /// @endcond

    ///
    /// @brief How long session lives after last ping.
    ///
    /// If server doesn't receive any pings for session transaction for this time
    /// session will be aborted. By default timeout is 15 seconds.
    FLUENT_FIELD_OPTION(TDuration, SessionTimeout);
};

struct TPingDistributedWriteFileOptions
{
    using TSelf = TPingDistributedWriteFileOptions;
};

struct TFinishDistributedWriteFileOptions
{
    using TSelf = TFinishDistributedWriteFileOptions;
};

////////////////////////////////////////////////////////////////////////////////

} // namespace NYT